原文鏈接：https://neucrack.com/p/342
簡(jiǎn)介
一款用 Python 寫(xiě)的文檔網(wǎng)站生成工具残制，支持從 Markdown 或者 jupyter notebook 轉(zhuǎn)換成 HTML荣恐，支持多文檔暇屋，多語(yǔ)言，支持自定義頁(yè)面等功能
效果和文檔（官網(wǎng)）： teedoc.neucrack.com 或者 https://teedoc.github.io/
軟件源碼: https://github.com/neutree/teedoc （歡迎 star）
文檔源文件: github.com/teedoc/teedoc.github.io
將 Markdown 或者 Jupyter Notebook 格式的文檔轉(zhuǎn)換為 HTML 網(wǎng)頁(yè)
以下場(chǎng)景可使用teedoc：
- 建文檔網(wǎng)站，并且最好支持放多份文檔，和自定義頁(yè)面
- 建
WiKi網(wǎng)站 - 建個(gè)人或者企業(yè)知識(shí)庫(kù)
- 建個(gè)人或者企業(yè)網(wǎng)站
其實(shí)已經(jīng)有很多類(lèi)似的工具了撼泛， read the docs, docusaurus，docsify澡谭，gitbook等等
之前自己用的gitbook愿题， 但是官方不維護(hù)了， 雖然市面上挺多現(xiàn)成的工具的蛙奖，要趁手潘酗，還是自己手?jǐn)]的好，于是就造了個(gè)輪子雁仲，相比 gitbook仔夺， 支持多線(xiàn)程構(gòu)建，更好的多文檔管理攒砖，SEO更友好（方便搜索引擎收錄網(wǎng)站）缸兔，最重要的是，有活人更新祭衩！
另外灶体，使用了 Python 作為開(kāi)發(fā)語(yǔ)言，足夠簡(jiǎn)單易用掐暮，要做自定義也很簡(jiǎn)單， 前端也只用了一個(gè)jquery政钟，沒(méi)有其它復(fù)雜的框架路克，相信很多開(kāi)發(fā)者都有能力基于這個(gè)進(jìn)行自定義開(kāi)發(fā)，另外也支持插件哦~
因?yàn)樽约汉凸径汲Ｄ暧形臋n公開(kāi)需求养交，會(huì)長(zhǎng)期維護(hù)~ 歡迎測(cè)試使用精算， 歡迎給項(xiàng)目一個(gè)star，你的 star 就是我維護(hù)的動(dòng)力哈哈哈
特性
- 使用簡(jiǎn)單碎连， 跨平臺(tái)灰羽，只依賴(lài)
Python3 - 部署簡(jiǎn)單， 生成的網(wǎng)站是全靜態(tài)頁(yè)面鱼辙，直接拷貝到服務(wù)器或者上傳到三方機(jī)構(gòu)即可部署
- 書(shū)寫(xiě)簡(jiǎn)單廉嚼，使用 Markdown 語(yǔ)法編寫(xiě)
- Jupyter notebook 支持
- 多文檔支持
- 插件支持
- 多主題支持（由插件實(shí)現(xiàn)）
- 多級(jí)目錄支持
- 多語(yǔ)言支持（手動(dòng)翻譯）(國(guó)際化/i18n)
- 多語(yǔ)言支持（自動(dòng)翻譯）
- 多版本支持（實(shí)現(xiàn)方法同多語(yǔ)言）
- 搜索支持
- SEO 友好
- 實(shí)時(shí)預(yù)覽更改
- 多線(xiàn)程構(gòu)建，更快的構(gòu)建速度
- 博客支持
使用
參見(jiàn)文檔： https://teedoc.github.io/ 或者 https://teedoc.gitee.io/
如果你已經(jīng)有 Python 環(huán)境倒戏，只需要：
- 安裝 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
- 本地預(yù)覽
teedoc serve
如果要部署的文件怠噪，請(qǐng)使用
teedoc build命令
然后訪問(wèn) http://127.0.0.1:2333
