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

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.5.1.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.1.tar.gz
Algorithm Hash digest
SHA256 0350ad8b989b18452c03ef35d0e884c0765656081aa363a28f680509f386aee6
MD5 9637915d80dbbc1ca43c4147c401a878
BLAKE2b-256 693b4a8ed29deff0c693e932baaa11e75d42d1ac0afeeddfdf64e0720fc22c59

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.5.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9ba8c7f1f8cf9f47d774f4d19dc7fa6ea1aa4e856fd306ee6c259d8426bbd5e3
MD5 d8080539ff9d6b6f9ad6ad18d30ab45b
BLAKE2b-256 a53980607ba7baabb4ed6934fd00ed900ac2871641135572a95124f6da3bf43e

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