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

Uploaded Source

Built Distribution

teedoc-1.11.0-py3-none-any.whl (473.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.11.0.tar.gz
  • Upload date:
  • Size: 450.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for teedoc-1.11.0.tar.gz
Algorithm Hash digest
SHA256 2d31609615465f7f421fa9fa95d5bd30ff8fa7241ff038444aa3afc98274403a
MD5 1ff67fb7d9096bca89c05011e4a6d73c
BLAKE2b-256 dad1028b2becbf1c83f13ed3a1eea0af22a608b411efca61b6d33f72e43d4cc4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.11.0-py3-none-any.whl
  • Upload date:
  • Size: 473.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for teedoc-1.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3d7280f8b5bf19ed5cefc2a009b5602efbb3cf9865ca74b206f73e2da97fb5ae
MD5 30f84db089e206e4f4360e5d27ffe49e
BLAKE2b-256 3e55c566c3083aae16bc1ec97752aa49f2e0856f693ac9163ff8a4115d7b9460

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