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

Uploaded Source

Built Distribution

teedoc-1.12.5-py3-none-any.whl (194.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.12.5.tar.gz
  • Upload date:
  • Size: 189.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.12.5.tar.gz
Algorithm Hash digest
SHA256 bfa228ce01f3052ff0fd56a1eaf551598a2887caec22f888c9e2a6a0686a9451
MD5 5424113812ba16c5f57abfc71277e001
BLAKE2b-256 a36f8bdade16b79869fa47af4d42cea93349dfaf41de647517f97c08654d902d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.12.5-py3-none-any.whl
  • Upload date:
  • Size: 194.2 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.12.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9cbfe558e0aaca18bed5d0b396f86426189370244b9d9a549c907e8e4b9791a5
MD5 10a1e92e194531d7e013ad8ee78601ed
BLAKE2b-256 9760228046dff57d0f6234da2533649f4c580db6e72e1d403771fb71ae7494d5

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