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.2

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

Uploaded Source

Built Distribution

teedoc-1.5.2-py3-none-any.whl (19.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.5.2.tar.gz
  • Upload date:
  • Size: 19.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.5.2.tar.gz
Algorithm Hash digest
SHA256 23a08cca0f94eee37adbd041275ebff1454c7d8b7998ed9292e1e5c793d0e82e
MD5 a93e346866b077533449b1d5ca2fcf9b
BLAKE2b-256 cb95306195172f79cb1c1b9601608dd51b8f8db17e06db976d0798959a53e703

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 19.7 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 de258388afdd2a91556d2f12b17149dc0d0f34ec6afaba17f7c2dd38664f40fb
MD5 ce8d838db1bc2894a69f567fe03f6766
BLAKE2b-256 ea0de883f371f0e18d348b76d9b8d4d45ca3775fc64336acf32cbab8d4bac191

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