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

Uploaded Source

Built Distribution

teedoc-1.15.7-py3-none-any.whl (195.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.15.7.tar.gz
  • Upload date:
  • Size: 190.7 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.7.tar.gz
Algorithm Hash digest
SHA256 1762e926fd7a751a5738891e0bd25fffabf17a7c7d734860c5506cb084431a94
MD5 7a0ed3118f7979779f7bf956392518f6
BLAKE2b-256 3d21fe246f5a0df1d2052169a7626df001dce4f9963807ac89f696b377ca590e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.15.7-py3-none-any.whl
  • Upload date:
  • Size: 195.6 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4e1442e1187b59f8fa6899476fa346579e9747fe09aec45663bd4b831f341110
MD5 d0967caa5e3d586d735966c0dc1730ff
BLAKE2b-256 493a382cd41e6c8e93d7f46109c9a75f94e8bf6e4af5e6e27279bad899cd9fc0

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