1 Star 6 Fork 1

teedoc / teedoc

Create your Gitee Account
Explore and code with more than 8 million developers,Free private repositories !:)
Sign up
Clone or Download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

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

Repository Comments ( 0 )

Sign in to post a comment

About

静态网站/文档网站生成工具,快速使用 markdown 或者 jupyter notebook 编写并生成 html 文档网站,建官网和文档以及知识库均适用,使用 python 编写,无需数据库,轻量稳定实用。可替代gitbook expand collapse
Cancel

Releases

No release

teedoc

Contributors

All

Activities

Load More
can not load any more
Python
1
https://gitee.com/teedoc/teedoc.git
git@gitee.com:teedoc/teedoc.git
teedoc
teedoc
teedoc
main

Search