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

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

Uploaded Source

Built Distribution

teedoc-1.10.0-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.10.0.tar.gz
  • Upload date:
  • Size: 21.8 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.10.0.tar.gz
Algorithm Hash digest
SHA256 6b0719eee2c3a32306798abbe21af529a21676536cf14993a736fe051bb9bf07
MD5 675028e1c06361894efef453f8321d31
BLAKE2b-256 ef886eff78e0460df3b5340a7e8044b407d25833540b55916032fafb5e2cfe9c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.10.0-py3-none-any.whl
  • Upload date:
  • Size: 22.5 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.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f21b7a57027e7adaa9457a2c6b8b7212667093516997b138fac05d550255efe4
MD5 ebf201aa312fc6d49b241aae7f669e6d
BLAKE2b-256 35980d4f7c57534dcd6db5d7942eee9daeecb1a3d43c816d0d83626b6ed7e2ea

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