1. teedoc
简介
一款用 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，没有其它复杂的框架，相信很多开发者都有能力基于这个进行自定义开发，另外也支持插件哦~
2. 特性
- 使用简单， 跨平台，只依赖
Python3 - 部署简单， 生成的网站是全静态页面，直接拷贝到服务器或者上传到三方机构即可部署
- 书写简单，使用 Markdown 语法编写
- Jupyter notebook 支持
- 多文档支持
- 插件支持
- 多主题支持（由插件实现）
- 多级目录支持
- 多语言支持（手动翻译）(国际化/i18n)
- 多语言支持（自动翻译）
- 多版本支持（实现方法同多语言）
- 搜索支持
- SEO 友好
- 实时预览更改
- 多线程构建，更快的构建速度
- 博客支持
3. 安装
安装之前需要python3的环境，如果没有的同学可以看此文章
https://blog.csdn.net/AnNanDu/article/details/123935023?spm=1001.2014.3001.5501mkdir /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，如下图
访问页面如下
如图即安装成功
本内容为合法授权发布，文章内容为作者独立观点，不代表开发云立场，未经允许不得转载。
