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.8.2

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

Uploaded Source

Built Distribution

teedoc-1.8.2-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.8.2.tar.gz
  • Upload date:
  • Size: 21.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.8.2.tar.gz
Algorithm Hash digest
SHA256 4022bfc7ac1322e4d560edc66ab3465dcbe68551447ce268fcf405373a2a6e9d
MD5 a8cbc045545d4b0da929c6ddcf31ce1f
BLAKE2b-256 d5eda303eadc1f568dfd7ad1800b60ddb0765543e0b7d7a5d1b5e7a31cfd3748

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.8.2-py3-none-any.whl
  • Upload date:
  • Size: 21.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 91ad7786b468030e6ee9656495381e50633447a24295e59610b548635701686e
MD5 8b33c55616fe2954b8bce957f9a9d93e
BLAKE2b-256 17a47f7a61829eebc08a8481e3fe022f4a9f1ce63a6ae9533d1557d1513bbdee

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