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

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

Uploaded Source

Built Distribution

teedoc-1.7.1-py3-none-any.whl (20.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.7.1.tar.gz
  • Upload date:
  • Size: 20.2 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.7.1.tar.gz
Algorithm Hash digest
SHA256 fe70d06831e572b7aa23dc45c4d2dcb3899091c8d8af0479316e282366a3e7b1
MD5 d1e95bb1bd6cda505fa5e1989b4ce65c
BLAKE2b-256 a649ec2888a61b26f1a2a78c93ec2585c13792e20c5be0746dea3958cc0b4f26

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.7.1-py3-none-any.whl
  • Upload date:
  • Size: 20.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.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 456050305642e79af4d01c43108a9e3db11c2be02bbfc1a8bde18da8dfc6ed1c
MD5 fb1fdd1648eb4ebff4d38b94f947f630
BLAKE2b-256 2f2bc805f8d9dc5e79e946ad54cc36a9fac6f9a7fb0f86a4b7a98e8c8b704892

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