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.neucrack.com or 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 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.12.0.tar.gz (450.2 kB view details)

Uploaded Source

Built Distribution

teedoc-1.12.0-py3-none-any.whl (473.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.12.0.tar.gz
  • Upload date:
  • Size: 450.2 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.12.0.tar.gz
Algorithm Hash digest
SHA256 96d361290471ef1f2254f274f53a0383bc0f0064e1185c020270d6f992497626
MD5 5a413098cf9ff176354d5a0e01956031
BLAKE2b-256 fc439df2494d7ed5b913ffa68b80365837c0978e3d8ce4dd6aaffdadcb594e5d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.12.0-py3-none-any.whl
  • Upload date:
  • Size: 473.3 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.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53c035125c9af1e03972a886d41c6c924de9945cd40616780b67a65913764a5b
MD5 a7f1ca679121a07257f4eebd0165e5a2
BLAKE2b-256 9f65c2b65752973aecb226ec98471ff18b2cea5be106db4baa9e58f428730ca3

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