开源文档网站生成工具 teedoc

原文链接：https://neucrack.com/p/342

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 网页

以下场景可使用teedoc：

• 建文档网站，并且最好支持放多份文档，和自定义页面
• 建WiKi网站
• 建个人或者企业知识库
• 建个人或者企业网站

其实已经有很多类似的工具了， read the docs, docusaurus，docsify，gitbook等等

之前自己用的gitbook， 但是官方不维护了， 虽然市面上挺多现成的工具的，要趁手，还是自己手撸的好，于是就造了个轮子，相比 gitbook， 支持多线程构建，更好的多文档管理，SEO更友好（方便搜索引擎收录网站），最重要的是，有活人更新！

另外，使用了 Python 作为开发语言，足够简单易用，要做自定义也很简单， 前端也只用了一个jquery，没有其它复杂的框架，相信很多开发者都有能力基于这个进行自定义开发，另外也支持插件哦~

因为自己和公司都常年有文档公开需求，会长期维护~ 欢迎测试使用， 欢迎给项目一个star，你的 star 就是我维护的动力哈哈哈

特性

• 使用简单， 跨平台，只依赖 Python3
• 部署简单， 生成的网站是全静态页面，直接拷贝到服务器或者上传到三方机构即可部署
• 书写简单，使用 Markdown 语法编写
• Jupyter notebook 支持
• 多文档支持
• 插件支持
• 多主题支持（由插件实现）
• 多级目录支持
• 多语言支持（手动翻译）(国际化/i18n)
• 多语言支持（自动翻译）
• 多版本支持（实现方法同多语言）
• 搜索支持
• SEO 友好
• 实时预览更改
• 多线程构建，更快的构建速度
• 博客支持

使用

参见文档： https://teedoc.github.io/ 或者 https://teedoc.gitee.io/

如果你已经有 Python 环境，只需要：

• 安装 teedoc

pip3 install teedoc

• 获取模板源码

git clone https://github.com/teedoc/teedoc.github.io my_site

或者

git clone https://gitee.com/teedoc/teedoc.gitee.io my_site

• 安装插件

cd my_site
teedoc install

• 本地预览

teedoc serve

如果要部署的文件，请使用 teedoc build命令

然后访问 http://127.0.0.1:2333