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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.12.4.tar.gz
  • Upload date:
  • Size: 191.0 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.12.4.tar.gz
Algorithm Hash digest
SHA256 642028cc3f26f9ac9e96cec95804c1a53a80c40bd79ab05d26bf0a9fefbe45d2
MD5 4fc1400cfabd7993ce1b498f7824bcfc
BLAKE2b-256 7674bffeedb9007daa2ccec3d6ea81c16607af84b2d0c12aaf863e9b0329eedf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.12.4-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/45.2.0.post20200210 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for teedoc-1.12.4-py3-none-any.whl
Algorithm Hash digest
SHA256 847d1d3f104dfd95c065afb18ef2c1ae0f9dae492dd049f23acad2e00d02ca6a
MD5 92d6a8582d127a89bc5b146b12691f2f
BLAKE2b-256 7c90d37eef94623694f998ecf78d27b11dad27c9c897cbb0305109f72ed73031

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