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

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

Uploaded Source

Built Distribution

teedoc-1.5.4-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.5.4.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.6.9

File hashes

Hashes for teedoc-1.5.4.tar.gz
Algorithm Hash digest
SHA256 248ecf315943f51551463e3343183c215b045c6de5480c9bbcf3da640813cf7d
MD5 d9bcc53405c0cb4e74aef8a5bb73e907
BLAKE2b-256 e2281a9b2b6b34fc28d4df3826d4e82f5da53e7c420b170e087c8a0f1943c61c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.5.4-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.28.1 CPython/3.6.9

File hashes

Hashes for teedoc-1.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d6af4793db1e7ac960b5ea436c52de10850545b792d19bd102d2b8ad0e61ab23
MD5 ae1978b6898f4a76132ef9bfc3859105
BLAKE2b-256 3613c8ffcf8479375e608eb24855f96b766d58f45a4f87db0a21b6a509e4ba07

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