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

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

Uploaded Source

Built Distribution

teedoc-1.8.0-py3-none-any.whl (21.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.8.0.tar.gz
  • Upload date:
  • Size: 20.5 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.8.0.tar.gz
Algorithm Hash digest
SHA256 e1dc1b1e0f67b2f54dd32cb0720b7f80c811d6f6f9ea4f22a7f9049a5861c2cc
MD5 10116512c60eefa4814d8d45bd58bca3
BLAKE2b-256 5763319e2610faa7ce6c8343715a19c673e7aa4fd5e4be2de7eb0226a7e10c03

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 21.0 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e13cf6757ab2b62c6d788e82cc54023d12d1978d9f59a576ceebebe795fea6fb
MD5 a06d7b4fd4ee34fcfd0ba86f140b67c5
BLAKE2b-256 3292be9f3c42d43c406f113744e2b641ff39596ead65869a1752a4d97cfcbe0d

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