Skip to main content

teedoc

Official website: teedoc.neucrack.com or teedoc.github.io Source code: https://github.com/teedoc/teedoc

Convert documents in Markdown or Jupyter Notebook format into HTML static web pages

teedoc can be used in the following scenarios:

  • Build a document website, and it’s best to support multiple documents and custom pages
  • Build a WiKi website
  • Build a personal or corporate knowledge base
  • Build a personal or corporate website
  • Blog

Features

  • Simple to use, cross-platform, only dependent on Python3
  • No database required, all static pages of the website
  • The deployment is simple, the generated website is a fully static page, which can be directly copied to the server or uploaded to a third party organization for deployment
  • Easy to write, using Markdown syntax
  • Jupyter notebook support
  • HTML support, you can directly use HTML to write pages, with great freedom
  • Multi-document support
  • Plug-in support
  • Multi-theme support (implemented by plug-in)
  • 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)
  • Multi-version support (implementation method is the same as multi-language)
  • Search support
  • SEO friendly
  • Real-time preview of changes
  • Multi-threaded construction, faster construction speed
  • Blog support

Demo

Official website is generated using teedoc, what you see now is what the generated website looks like.

In addition, there are other websites that use teedoc, please see here for details