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.github.io or teedoc.gitee.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.10.1.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

teedoc-1.10.1-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.10.1.tar.gz
  • Upload date:
  • Size: 21.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.10.1.tar.gz
Algorithm Hash digest
SHA256 2f64ab1f9bf9aaa1e5afbfa8c65453397308a55a8504f2125f938cdf40bfa59a
MD5 02dde465f68fcd95f4212c089831b7ec
BLAKE2b-256 3ad83a7ba48039181527d2ccba476e981212bb826a9c2f604645b0a1e57e77d0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.10.1-py3-none-any.whl
  • Upload date:
  • Size: 22.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.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a67cfb98fb0e1697f97811e1596d1654b1a479c6dc4eac1a2daa67e21e83d84e
MD5 577147f5942977938857b70413ae0abc
BLAKE2b-256 09524b8bcf7fb7511e6e2a7ffbbbb8345f3f7a12b7fec1d677abb384ade14a3d

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