doc site generator with multiple doc support

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Neucrack from gravatar.com Neucrack

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Neucrack
  • Tags doc, website, markdown, jupyter, notbook, generator, teedoc
Classifiers

Project description

teedoc

中文 README

License PyPI PyPI - Downloads PyPI - Downloads GitHub Repo stars

Official site: teedoc.neucrack.com or 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
  • Jinja2 HTML layout template support

Get Started

Visit official site: teedoc.github.io or teedoc.gitee.io

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Neucrack from gravatar.com Neucrack

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Neucrack
  • Tags doc, website, markdown, jupyter, notbook, generator, teedoc
Classifiers

Release history Release notifications | RSS feed

1.37.7

1.37.6

1.37.5

1.37.4

1.37.3

1.37.2

1.37.1

1.37.0

1.36.4

1.36.3

1.36.2

1.36.1

1.36.0

1.35.0

1.34.1

1.34.0

1.33.3

1.33.1

1.33.0

1.32.1

1.32.0

1.31.2

1.31.1

1.31.0

1.30.1

1.30.0

1.29.13

1.29.12

1.29.11

1.29.10

1.29.9

1.29.8

1.29.7

1.29.6

1.29.5

1.29.4

1.29.3

1.29.2

1.29.1

1.29.0

1.28.3

1.28.2

1.28.1

1.28.0

1.27.1

1.27.0

1.26.9

1.26.8

1.26.7

1.26.6

1.26.5

1.26.4

1.26.3

1.26.2

1.26.1

1.26.0

1.25.0

1.24.0

1.23.14

1.23.13

1.23.12

1.23.11

1.23.10

1.23.9

1.23.8

1.23.7

1.23.6

1.23.5

1.23.4

1.23.3

1.23.2

1.23.1

1.23.0

1.22.3

1.22.2

1.22.1

1.22.0

1.21.4

1.21.3

1.21.2

1.21.1

1.21.0

1.20.1

1.19.1

1.19.0

1.18.0

1.17.7

1.17.6

1.17.5

1.17.4

1.17.3

1.17.2

This version

1.17.1

1.17.0

1.16.3

1.16.2

1.16.1

1.16.0

1.15.8

1.15.7

1.15.6

1.15.5

1.15.4

1.15.3

1.15.2

1.15.1

1.15.0

1.14.0

1.13.0

1.12.5

1.12.4

1.12.3

1.12.2

1.12.1

1.12.0

1.11.1

1.11.0

1.10.1

1.10.0

1.9.0

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.2

1.7.1

1.7.0

1.6.0

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.2

1.2.1

1.2.0

1.1.1

1.1.0

1.0.1

1.0.0

0.1.3

0.1.2

0.1.1

0.1.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.17.1.tar.gz (192.5 kB view details)

Uploaded Source

Built Distribution

teedoc-1.17.1-py3-none-any.whl (196.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: teedoc-1.17.1.tar.gz
  • Upload date:
  • Size: 192.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.6

File hashes

Hashes for teedoc-1.17.1.tar.gz
Algorithm Hash digest
SHA256 1d94d4381f794b72d92aac1f3051bd715ea4d46484a7f7a1c8eaa7b6bcf7b90d
MD5 1d7c62305a62f3637294cd564af84463
BLAKE2b-256 5d4bef53702b3def869927361ecf326117f1c02bbb9b4554214e5c1a6afa1e18

See more details on using hashes here.

File details

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

File metadata

  • Download URL: teedoc-1.17.1-py3-none-any.whl
  • Upload date:
  • Size: 196.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.7.6

File hashes

Hashes for teedoc-1.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dcda18660b0ea5d6a65b422487bdb9c133be219a4f3fc15ff7bea18575fa836c
MD5 e1829c6e5a4baaf5d5e70a45945eade2
BLAKE2b-256 13a54f2e3d92922baf8a0827a4f6f81b85e439de08e3cf0ac92f8fa533196323

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