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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.15.3.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.3.tar.gz
Algorithm Hash digest
SHA256 36685624f08c3400da19f89fdf4c82fd96006971e65572c22bf0f6294343d81c
MD5 d3a81a5bd5ad951fd1b837a94d722f8c
BLAKE2b-256 73a955186759e5f9012483cedb9d72abcc5ba240004904b29b48921f43606455

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.15.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 23378c62f97dbf909d9788638b804abecdd99ece737ad7787804ab49961ebf3e
MD5 f0b4ea30d265a1778b593f63258a8a4c
BLAKE2b-256 695ff242e72f52691baac9ef17dbd0374748e0c51e722009eb02f4f7408c478a

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