teedoc

teedoc

中文|英语

官方网站：teedoc.neucrack.com或teedoc.github.io

更多演示：请参阅此处或这里

文档从Markdown和Jupyter笔记本到HTML生成工具

teedoc可以在以下情况下使用：

• 建立一个文档网站，最好支持多个文档和自定义页面
• 组织“或公司”文档在不同的领域中传播，希望将它们合并到一个站点（域）
• 建立WiKi网站
• 建立个人或公司知识库
• 建立个人或公司网站

特征

• 易于使用的跨平台，只需要Python3
• 易于部署，仅将生成的Staitc HTML文件复制到您的服务器或其他主机
• 易于编写，降级支持
• Jupyter笔记本电脑支持
• 多个文档支持
• 插件支持
• 多个主题支持（插件支持）
• 通过CSS控制页面的精度（通过自定义每个页面的ID和类实现）
• 多级目录支持
• 多语言支持（手动翻译）（国际化/I18N）
• 多语言支持（翻译插件）
• 多版本支持
• 搜索支持
• SEO友好
• 实时预览文件更改
• 平行构建，更快的构建速度
• 博客支持
• Jinja2 HTML布局模板支持

开始

访问官方网站：teedoc.github.io或teedoc.neucrack.com

几分钟之内在GitHub页面上创建您的网站

请参阅模板回购

Quik开始

• 安装Python3

在Windows或macOS上，从python.org下载

在Linux上，例如Ubuntu ：

 sudo apt install python3 python3-pip

• 安装TEEDOC

此命令将安装TEEDOC程序

 pip3 install -U teedoc

• 初始化文档

 mkdir my_site
cd my_site
teedoc init

或者

 teedoc -d my_site init

在促销中选择最小模板

• 安装插件

此命令将安装DOC使用的插件（在site_config.json中设置）

 cd my_site
teedoc install

• 建造或服务

 teedoc serve

然后在浏览器中访问http://127.0.0.0.1:2333

如果您只想生成HTML：

 teedoc build