Skip to main content

doc site generator with multiple doc support

Project description

teedoc

中文 | English

License PyPI PyPI - Downloads PyPI - Downloads build GitHub Repo stars

Official site: teedoc.neucrack.com or teedoc.github.io

More demo: see here or here

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
  • Organizations' or companies' docs spread in different domains, wish to combine them to one site(domain)
  • 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
  • Multi-language support (manual translation) (Internationalization/i18n)
  • Multilingual support (translation plugin)
  • Multiple version support
  • Search support
  • SEO friendly
  • Real-time preview file changes
  • Parallel build, faster build speed
  • Blog support
  • Jinja2 HTML layout template support

Get Started

Visit official site: teedoc.github.io or teedoc.neucrack.com

Create your website on github pages in minutes

See template repo

Quik start

  • Install python3

On Windows or macOS, download from python.org

On Linux, Ubuntu for example:

sudo apt install python3 python3-pip
  • Install teedoc

This command will install teedoc program

pip3 install -U teedoc
  • Initialize document
mkdir my_site
cd my_site
teedoc init

or

teedoc -d my_site init

select minimal template in promot

  • Install plugins

This command will install plugins used by doc(set in site_config.json)

cd my_site
teedoc install
  • build or serve
teedoc serve

then visit http://127.0.0.1:2333 in browser

If you only want to generate htmls:

teedoc build

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

Uploaded Source

Built Distribution

teedoc-1.26.6-py3-none-any.whl (862.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.26.6.tar.gz
  • Upload date:
  • Size: 853.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.26.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for teedoc-1.26.6.tar.gz
Algorithm Hash digest
SHA256 7d27b55167c3e1404f1383b942261bac2c725444b368424a5e72bc4abe892ad3
MD5 9a6a6de3d29e4a5d53ad7ef030fadc5b
BLAKE2b-256 d68491a13279b86a2873ccd8ba9b0d68e3cf61b7fa0303e3bb03c627efd7ed23

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.26.6-py3-none-any.whl
  • Upload date:
  • Size: 862.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.26.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for teedoc-1.26.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1b933033ea2aec68e576094148457e68015ddf9552495e4e8ce9bffe44ba5753
MD5 87a469d3fe32f3ac28ca4d0510d8d6c4
BLAKE2b-256 3f62ffc8f83e592d6eba7b7282dad306115e28be07ca8f56087a1ec41a941278

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