Skip to main content

doc site generator with multiple doc support

Project description

teedoc

中文 README

License PyPI PyPI - Downloads PyPI - Downloads GitHub Repo stars

Official site: teedoc.github.io

documentation generate tool from markdown and jupyter notebook to html

teedoc can be used in the following scenarios:

  • Build a document website, and it is best to support multiple documents and custom pages
  • Build a WiKi website
  • Build personal or corporate knowledge base
  • Build personal or corporate website

Features

  • Easy to use, cross platform, only need Python3
  • Easy to deploy, only copy generated staitc HTML files to your server or other host
  • Easy to write, markdown support
  • Jupyter notebook support
  • Multiple docs support
  • Plugin support
  • Multiple theme support(support by plugin)
  • Control the style accurate to the page through css (implemented by customizing the id and class of each page)
  • Multi-level directory support
  • Multiple language support(manually translate)
  • Multiple language support(auto translate)
  • Multiple version support
  • Search support
  • SEO friendly
  • Real-time preview file changes
  • Multiple thread support, faster build speed
  • Blog support

Get Started

Visit official site: teedoc.github.io

Project details


Release history Release notifications | RSS feed

This version

1.8.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

teedoc-1.8.1.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

teedoc-1.8.1-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file teedoc-1.8.1.tar.gz.

File metadata

  • Download URL: teedoc-1.8.1.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for teedoc-1.8.1.tar.gz
Algorithm Hash digest
SHA256 d9883ed24458af58ca9041f1bbb81b48d7a1866a1ef641208acdf7596892f867
MD5 84c5d151f3c29803d4c24ca1753baec5
BLAKE2b-256 3b9d88281407e31368a2ffe5d57ef9f114930d9251b1e1f362c21eef8dae1b0f

See more details on using hashes here.

File details

Details for the file teedoc-1.8.1-py3-none-any.whl.

File metadata

  • Download URL: teedoc-1.8.1-py3-none-any.whl
  • Upload date:
  • Size: 21.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for teedoc-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2c09bc8527bf867bd729bc8c56ff4274f47576d593a1f02de4eacab01b4fb0fe
MD5 aced5e79639267dfb3bfe3dac2cb9d33
BLAKE2b-256 097607487edd87c13cb9e8d1348dc3861b953e294a531e535762a30929e59808

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page