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