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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.11.1.tar.gz
  • Upload date:
  • Size: 22.4 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.11.1.tar.gz
Algorithm Hash digest
SHA256 f5606ef423a01c20776df36eae07e9b701b129dadc14941e2a744c8a01252be4
MD5 95e50804aacc8e8848d873e1b03d7890
BLAKE2b-256 c92b008cf35d0f33c642617f342b7113033f9967e747b65957980af91ff2c594

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.11.1-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.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5d6143194e8b39752b7298cafc4e48c36ee3b82ee19b355c43d323c4182f4326
MD5 e870720cd157aa91cc6338747250b150
BLAKE2b-256 9d5e858b9c4e338f7ea0a23f7f1e6fe974732452a62dc350441d6ac7b6eb1186

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