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

Uploaded Source

Built Distribution

teedoc-1.16.1-py3-none-any.whl (195.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.16.1.tar.gz
  • Upload date:
  • Size: 190.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.6

File hashes

Hashes for teedoc-1.16.1.tar.gz
Algorithm Hash digest
SHA256 5c74d27342248f305f929d8b0e1d0025c6d30cf74c1d8428cd31defbfe5bf224
MD5 1a712851dc1343c3670c548ef4377908
BLAKE2b-256 11d3d04c29372c479fdf838e4bae69e0404b78d02811881a987ceff90bba76fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.16.1-py3-none-any.whl
  • Upload date:
  • Size: 195.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.6

File hashes

Hashes for teedoc-1.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd96f09109e03900280056353ad500c605ed84a00b1d70e9a9037816206eab80
MD5 eac26409130d708c61497220dbaef752
BLAKE2b-256 4056cfa6672ac2a016587816539eaed81b362dee06316ebf9a595c0a4b8f6e08

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