Skip to main content

doc site generator with multiple doc support

Project description

teedoc

中文 README

Official site: 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

Project details


Release history Release notifications | RSS feed

This version

1.5.0

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

Uploaded Source

Built Distribution

teedoc-1.5.0-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.5.0.tar.gz
  • Upload date:
  • Size: 18.8 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.5.0.tar.gz
Algorithm Hash digest
SHA256 0bab646af48eb7bd54383786f1a82de5c81a23a1a2816b9e76f0a3e5c1cfb0c1
MD5 0a038bfe0e8a4c9ebf76de01057c012e
BLAKE2b-256 dac8f84e561fa6013c9c8276b3794bbc26e2212b72f56fbe733d533d043f922e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 19.5 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f22e5d3b51bcffc5942c84876fc595747a51be69a43a132913774336a26d5d2
MD5 e3a101ca8116cecc7731836c50a9ad3f
BLAKE2b-256 4735ff39bd8f69e2e2fe6448946c015e8aefc2b0e0dd69140dde13a5acee715a

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