一款用 Python 写的文档网站生成工具,支持从 Markdown 或者 jupyter notebook 转换成 HTML,支持多文档,多语言,支持自定义页面等功能
效果和文档(官网): teedoc.neucrack.com 或者 https://teedoc.github.io/ 软件源码: https://github.com/neutree/teedoc (欢迎 star) 文档源文件: github.com/teedoc/teedoc.github.io
将 Markdown 或者 Jupyter Notebook 格式的文档转换为 HTML 网页
像其他工具也有read the docs
, docusaurus
,docsify
,gitbook
等等
teedoc使用了 Python
作为开发语言,足够简单易用,要做自定义也很简单, 前端也只用了一个jquery
,没有其它复杂的框架,相信很多开发者都有能力基于这个进行自定义开发,另外也支持插件哦~
Python3
安装之前需要python3的环境,如果没有的同学可以看此文章
https://blog.csdn.net/AnNanDu/article/details/123935023?spm=1001.2014.3001.5501创建文件并位移目录
mkdir /usr/local/teedoc
cd /usr/local/teedoc
安装teedoc
pip3 install teedoc
如果报错如下
提示版本过低,升级版本,升级命令如下:
pip3 install --upgrade pip
升级完成后再次执行安装,如下图安装成功
克隆源码
git clone https://github.com/teedoc/teedoc.github.io my_site
等待克隆完成
移动至my_site目录
cd my_site/
安装插件
teedoc install
临时启动
teedoc serve
启动完成后访问ip+端口,默认端口为2333,如下图
访问页面如下
如图即安装成功