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

This version

1.8.3

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

Uploaded Source

Built Distribution

teedoc-1.8.3-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.8.3.tar.gz
  • Upload date:
  • Size: 21.1 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.8.3.tar.gz
Algorithm Hash digest
SHA256 2396f9570cad8e99bb6ebcec869317b7bf099061dd2aa71bd372631f5ea34990
MD5 83b243155f67f051462e929c777dad52
BLAKE2b-256 87fbd06a699d83ef010bbe93665e976acf60a2d423b4d37c4cb2ed434e931605

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.8.3-py3-none-any.whl
  • Upload date:
  • Size: 21.8 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.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0c0cfe7be4b462be250bb5412df308f3a1cf66193ea53f4a7963cd485e71c222
MD5 143396194e066e4bf653359938368f23
BLAKE2b-256 b84f319c81028c940b68ac437c76c9df047d16b85b91e0e19d8badc6538d0912

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