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.neucrack.com or 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 or teedoc.gitee.io

Project details


Release history Release notifications | RSS feed

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.15.2.tar.gz (190.5 kB view details)

Uploaded Source

Built Distribution

teedoc-1.15.2-py3-none-any.whl (195.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for teedoc-1.15.2.tar.gz
Algorithm Hash digest
SHA256 077e832a92ca60e9cc491cf5770798e07c32e181120b5481da7e342f0e9acbba
MD5 273da7373f2393c2c82b26c0994a6dc0
BLAKE2b-256 8c6c30591a94778f6ce09e21e3f8f1802c605cf97d53a7774af57c40eb9e4564

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for teedoc-1.15.2-py3-none-any.whl
Algorithm Hash digest
SHA256 11b74c5f160e02c774104548fbbf01d61c776d1d795ae35ba971f4a6f582cf4b
MD5 6ea980c8dd0ccd116d130d7ed2bef186
BLAKE2b-256 d744c31f99c42830d5dff5dcdd489513d76bd11878275d0f2fb12628a49af6b1

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