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

Uploaded Source

Built Distribution

teedoc-1.15.1-py3-none-any.whl (195.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.15.1.tar.gz
  • Upload date:
  • Size: 190.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for teedoc-1.15.1.tar.gz
Algorithm Hash digest
SHA256 361cc061b8e8bee5f8d862cf389a3e24ed346092108779e98627d51957dd2610
MD5 b3626e966632c81abe04f3a4a6a1298a
BLAKE2b-256 25bac541b9c2931b26f03f8e99deec4428cf2c55fe100cef64da4e1dde38a28c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.15.1-py3-none-any.whl
  • Upload date:
  • Size: 195.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for teedoc-1.15.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f44315a7aed3afbc61a20e22015adef814e5db591470ca6cfd70af753dba6e56
MD5 5c6eda30f61a52e5adbf2ad17da2791d
BLAKE2b-256 f46a439ad6768c2def98d62b7798fe4691e6771df00f7a5a9eca4531a26907d4

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