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

Uploaded Source

Built Distribution

teedoc-1.16.2-py3-none-any.whl (195.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.16.2.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.2.tar.gz
Algorithm Hash digest
SHA256 dbbc510e1fd4bbee252ca4568220b6011e9a453c50164b7d690cd27f20def323
MD5 6862a7038ba5260e8d02bfc8ea2637cd
BLAKE2b-256 b1f5228c2a8408bcdd6bc8dbe28b9a688b2be74cfde7843d5c87dcfd4197ca63

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.16.2-py3-none-any.whl
  • Upload date:
  • Size: 195.9 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 db5b431579d400ae708f56bf3f485d61c540e8b884cc632f498670a095c669f6
MD5 fc400d45230078f71d10b8fb9fb7ef36
BLAKE2b-256 eeefece402a30207c0abd32b34105f190ed74b1bbcb3760a3689b40493a895d9

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