teedoc 开源静态文档网站生成工具教程

teedoc 开源静态文档网站生成工具教程

teedoc wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具 项目地址: https://gitcode.com/gh_mirrors/te/teedoc

1. 项目介绍

teedoc 是一个开源的静态文档网站生成工具，支持将 Markdown 和 Jupyter Notebook 转换为 HTML 静态网页。它适用于个人或企业建站、建博客、建资料库、wiki 等多种场景。teedoc 具有以下特点：

• 易于使用：跨平台，只需 Python3。
• 易于部署：只需将生成的静态 HTML 文件复制到服务器或其他托管平台。
• 易于编写：支持 Markdown 和 Jupyter Notebook。
• 多文档支持：支持多个文档和自定义页面。
• 插件支持：支持多种插件，包括多主题支持。
• 多语言支持：支持手动翻译和多语言插件。
• SEO 友好：支持实时预览文件变化，并行构建，快速构建速度。

2. 项目快速启动

安装 Python3

在 Windows 或 macOS 上，可以从 python.org 下载 Python3。在 Linux 上，例如 Ubuntu，可以使用以下命令安装：

sudo apt install python3 python3-pip

安装 teedoc

使用 pip 安装 teedoc：

pip3 install -U teedoc

初始化文档

创建一个新的文档目录并初始化：

mkdir my_site
cd my_site
teedoc init

在提示中选择 minimal 模板。

安装插件

安装文档所需的插件：

cd my_site
teedoc install

构建或服务

启动服务并访问 http://127.0.0.1:2333：

teedoc serve

如果只想生成 HTML 文件：

teedoc build

3. 应用案例和最佳实践

应用案例

• 个人博客：使用 teedoc 可以快速搭建个人博客，支持 Markdown 和 Jupyter Notebook，方便内容创作。
• 企业文档：企业可以将分散在不同域名的文档整合到一个网站中，方便管理和查阅。
• 知识库：个人或企业可以使用 teedoc 构建知识库，支持多文档和多版本管理。

最佳实践

• 多文档管理：使用 teedoc 的多文档支持功能，将不同主题的文档分类管理，方便用户查找。
• SEO 优化：利用 teedoc 的 SEO 友好特性，自定义页面关键词和生成 sitemap，提升网站在搜索引擎中的排名。
• 插件扩展：根据需求安装和配置插件，例如多语言插件、主题插件等，提升用户体验。

4. 典型生态项目

• teedoc-plugin-theme-default：teedoc 的默认主题插件，提供高效阅读的设计。
• teedoc-plugin-search：支持全文搜索的插件，方便用户快速查找内容。
• teedoc-plugin-multilang：多语言支持插件，支持手动翻译和自动翻译。

通过这些生态项目，teedoc 可以更好地满足不同用户的需求，提供更丰富的功能和更好的用户体验。

teedoc wiki and multi docs friendly static document site generator(doc generator), convert markdown and jupyter notebook to html website. wiki 和多文档友好的静态文档网站生成工具 项目地址: https://gitcode.com/gh_mirrors/te/teedoc