Skip to main content

doc site generator with multiple doc support

Project description

teedoc

中文 README

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

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

Uploaded Source

Built Distribution

teedoc-1.4.5-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.4.5.tar.gz
  • Upload date:
  • Size: 18.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.4.5.tar.gz
Algorithm Hash digest
SHA256 6832d6c79558eadb4f5e612cfaa19088425ff55ae778bf96e30d22c05cf76f6f
MD5 4a7e1787981069746ccf0028b4bf5e1c
BLAKE2b-256 0b0388c37d405bc3c6e1c0ec1fa93b63ef7e0389f10a238d9953ffd78415d2b5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.4.5-py3-none-any.whl
  • Upload date:
  • Size: 18.9 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.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4e995f934bba7ad32ccbc7e5877e5b15cf8a8e5c7fb6f095f7fbffc8a162556f
MD5 3b9808db8207ed41971f7377a0bb944d
BLAKE2b-256 fa643a88aa18273f89ee5f29ffc3a970236695df2362a0ff802e4fdb23827abe

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