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

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

Project details


Release history Release notifications | RSS feed

This version

1.6.0

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

Uploaded Source

Built Distribution

teedoc-1.6.0-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.6.0.tar.gz
  • Upload date:
  • Size: 19.7 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.6.0.tar.gz
Algorithm Hash digest
SHA256 22ea6e56fc341f684ab64a6e3a7b8c86207aa1e8d97df6ce0c3693f0eb1ce9b9
MD5 535feb60f5cc63434a2e528e1fe3b806
BLAKE2b-256 05903d3577b3ff4826a828c168833f283acb7495c04fbc4f68090d2b4d0872aa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 20.3 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5edcb84e556cf9c40e978172a0e5e260fb2b9911672e8f4a7bcc742bd6694387
MD5 25ee8d287b0732874f6c654f7f78fce3
BLAKE2b-256 314d29d28bbbf96fefa2ac361b668dabfc6fef1a0a44912137532c26df06f39d

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