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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.16.0.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.0.tar.gz
Algorithm Hash digest
SHA256 d6ea23cb5d343643135c65f57db4d2d3b1a81ff8e0236e8d20cc8f71409ac900
MD5 e807e155ff91e327c1876de2ec29f995
BLAKE2b-256 5d26454f8a417c164735a559eebc16ce1e95979547496b437cf4c586f5af7fae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.16.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69c592131db71927664abb2bfac9d06e22b852794b60067ad141922896b05d95
MD5 4a9c9f5ce789d6eaa0348ee8942c207a
BLAKE2b-256 2295965988e04ac2e199006b910d2a40f9f78e399dca3ab88d74b706fb2272b5

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