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

Uploaded Source

Built Distribution

teedoc-1.13.0-py3-none-any.whl (194.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.13.0.tar.gz
  • Upload date:
  • Size: 189.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.13.0.tar.gz
Algorithm Hash digest
SHA256 708b645af705ac45bf71ba7630e721266bdb342428d484d40346a2c8e0da1303
MD5 ea24b5dbeacc0025d35549f5a5ffe4ff
BLAKE2b-256 47e3cbbaaf7bf9b1ea7088306b75fbd2e0390a96693e3093921e38cb787d6f97

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.13.0-py3-none-any.whl
  • Upload date:
  • Size: 194.2 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.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f8bdf95bcd58623352f712bcc0c331d772b359cc80856faceee778190a7e501f
MD5 3875ed05a54d094c6a2a36bc226d804a
BLAKE2b-256 9b5ebe716c1155f5a1ced30216dc8f9d14b5ac70bed51ddf90831a51139075ab

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