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

This version

1.9.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.9.0.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

teedoc-1.9.0-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.9.0.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for teedoc-1.9.0.tar.gz
Algorithm Hash digest
SHA256 ad004766103dcf842b168d49a424504db0a5c9c291d9d30d29df08a885633183
MD5 9ca9099df33d6c1628d803fe8eb9e8b2
BLAKE2b-256 b947c97bd2ae7057d340408dbb4d6c9e42354b2857e54438a3b8954cf8c0a21f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for teedoc-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3f2f8ac28b740f8b11b72d93114aa0bd95e00848d46edfb4b33b0076f0eea5ad
MD5 947271b905a61af96341283cb2316031
BLAKE2b-256 13ec097cbbe2adb90a3f6d24ed96e24201674be1c6fe79a71ee14b5e4a1b4834

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