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

Uploaded Source

Built Distribution

teedoc-1.15.4-py3-none-any.whl (195.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.15.4.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.4.tar.gz
Algorithm Hash digest
SHA256 e2a921d200e4f1ea354de0a9a0cecac0b92ec4656370d54e5d27eefccb3c739d
MD5 e942d1a4437726bff6801fbae0f1f48e
BLAKE2b-256 5271efed82479ecf69e0f340ffbeccb2783614b33a8b92dd84b8bf75fb556920

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.15.4-py3-none-any.whl
  • Upload date:
  • Size: 195.3 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ce803647361b7b673907b8bfc5cd99e7f90d6d631fc496ef81dc5d15174e1630
MD5 2f069c33919fc14ec6cfb1c9ef889205
BLAKE2b-256 3f231eef9c0501247d683c969dad1e75eec030decebd8edb81841f3c58f54dee

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