wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具
中文 | English
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:
WiKi
websitePython3
Visit official site: teedoc.github.io or teedoc.neucrack.com
See template repo
On Windows
or macOS
, download from python.org
On Linux
, Ubuntu
for example:
sudo apt install python3 python3-pip
This command will install teedoc program
pip3 install -U teedoc
mkdir my_site
cd my_site
teedoc init
or
teedoc -d my_site init
select minimal template in promot
This command will install plugins used by doc(set in site_config.json
)
cd my_site
teedoc install
teedoc serve
then visit http://127.0.0.1:2333 in browser
If you only want to generate htmls:
teedoc build