轻巧、稳定、无数据库的网站生成工具

界面展示

功能概述

teedoc是一个将Markdown或Jupyter Notebook格式文档转换为HTML网页的工具，适用于以下场景：

• 建立文档网站，支持多份文档和自定义页面。
• 整合多个域名上分散的文档至一个域名下。
• 创建WiKi网站。
• 构建个人或企业知识库。
• 设立个人或企业网站。

特性

teedoc具有以下特性：

• 使用简便，跨平台，仅依赖Python3。
• 部署简单，生成的网站是全静态页面，可直接拷贝至服务器或上传至第三方机构进行部署。
• 书写简单，采用Markdown语法编写。
• 支持Jupyter Notebook。
• 多文档支持。
• 插件扩展。
• 多主题支持（由插件实现）。
• 通过CSS精确控制每页样式（通过自定义每页的ID和Class实现）。
• 多级目录支持。
• 多语言支持（手动翻译）（国际化/i18n）。
• 多语言支持（翻译插件）。
• 搜索功能。
• SEO友好。
• 实时预览更改。
• 并行构建，提高构建速度。
• 博客支持。
• Jinja2 HTML布局模板支持。

技术选型

快速开始

1. 安装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

安装插件

pip3 install -U teedoc

或者

teedoc -d my_site init

• 安装插件

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

cd my_siteteedoc install

构建或预览

<br>teedoc build