teedoc

中文 | English

官网: teedoc.neucrack.com 或者 teedoc.github.io

更多样例: 看这里 或 这里

将 Markdown 或者 Jupyter Notebook 格式的文档转换为 HTML 网页

以下场景可使用teedoc：

• 建文档网站，并且最好支持放多份文档，和自定义页面
• 组织或者企业有很多份文档分散在各个域名，希望统一到一个域名下
• 建WiKi网站
• 建个人或者企业知识库
• 建个人或者企业网站

Features

• 使用简单， 跨平台，只依赖 使用简单， 跨平台，只依赖 `Python3`
• 部署简单， 生成的网站是全静态页面，直接拷贝到服务器或者上传到三方机构即可部署
• 书写简单，使用 Markdown 语法编写
• Jupyter notebook 支持
• 多文档支持
• 插件支持
• 多主题支持（由插件实现）
• 通过 css 控制精确到页的样式（通过自定义每页的 id 和 class 实现）
• 多级目录支持
• 多语言支持（手动翻译）(国际化/i18n)
• 多语言支持（翻译插件）
• 搜索支持
• SEO 友好
• 实时预览更改
• 并行构建，更快的构建速度
• 博客支持
• Jinja2 HTML 布局模板支持

开始使用吧

官网: teedoc.github.io 或者 teedoc.neucrack.com

几分钟内在 github pages 服务上搭建你自己的网站

查看 template 仓库

快速开始

• 安装 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

根据提示选择 minimal 模板

• 安装插件

这条命令会 安装文档需要的插件(在site_config.json里设置)

cd my_site
teedoc install

• 构建（build） 或者 预览（serve）

teedoc serve

然后浏览器访问 http://127.0.0.1:2333

如果只需要构建生成网页:

teedoc build