一、何制使用 MkDocs
MkDocs 是作自制作一個(gè)輕量級、易用(yong)的網(wǎng)站網(wǎng)站文件靜態(tài)網(wǎng)站生成器，專(zhuān)為文檔網(wǎng)站設計，何制支持 Markdow( ?ヮ?)n 編寫(xiě)和多種主題。作自制作
1. 安裝與創(chuàng )建項目
安裝：通過(guò) pip 安裝
```bash
pip install mkdocs
```
創(chuàng )建項目：在終端執行
```bash
mkdocs new my_docs
```
生成 `my_docs` 目錄，網(wǎng)站網(wǎng)站文件包含 `mkdocsヾ(′?｀)?.yml` 配置文件和 `docs` 存放文檔的何制文件夾。
2. 配置與內容編輯
基礎配置：編輯 `mkdocs.yml(′_｀)` 設置站點(diǎn)名稱(chēng)、作自制作URL、網(wǎng)站網(wǎng)站文件導航菜單等。何制
編寫(xiě)文檔：在 `docs` 目錄下創(chuàng )建 `.md` 文件，作自制作如 `index.md` 作為首頁(yè)。網(wǎng)站網(wǎng)站文件
本地預覽：運行 `mkdocs serve` 啟動(dòng)本地服務(wù)器，何制訪(fǎng)問(wèn) `http://127.0.0.1:8000` 查看效果。作自制作
主題切換：支持 Material、網(wǎng)站網(wǎng)站文件Rヽ(′?｀)ノead the Docs 等主題，通過(guò)(guo)配置文件修改。
插件擴展：可添加搜索、(╯°□°）╯國際化等功能模塊。
二、使用 Docu(′Д` )saurus
Docusaurus 是由 Facebook 開(kāi)發(fā)的文檔網(wǎng)站生成器，基于 React 開(kāi)發(fā)，支持 Markdown 和組件化開(kāi)發(fā)。
1. 安裝與項目創(chuàng )??建
環(huán)境要求：需 Node.js （≥14 或 16.14） 和(he) npm。
創(chuàng )建項目┐(′?｀)┌：??執行
```bash
npx create-docusaurus@latest my-website classic
```
使用 `classic` 模板生成基礎項目結構。
2. 配置與內容??管理
基礎配置：編輯 `docusaurus.config.js` 設置標題、組織信息等。
添加內容：在 `docs` 目錄創(chuàng )建 `.md` 文件，或通過(guò) `src` 目錄添加組件。
本地預覽：運行 `npm start` 啟動(dòng)開(kāi)發(fā)服務(wù)器，訪(fǎng)問(wèn) `http://loca(╯‵□′)╯lhost:3000`。
3. 高級功能
搜索與國際化：內置搜索功ヾ(′?｀)?能，支持多語(yǔ)言文檔。
部署：支持部署到 GitHub Pages 或 Vercel，生成靜態(tài)文件。
三、注意事項
單頁(yè)文檔推薦使用 MkDocs；
多頁(yè)面/組件化文檔建議使用 Docusaurus。
優(yōu)先選擇官方主題（如 Material、Read the Docs），便于維護和更新。
通過(guò)插件擴展功能，如搜索、版本控制等。
Vercel/Docusaurus(′?｀*)：支(′?｀)持自動(dòng)化ヽ(′?｀)ノ部署和持續集(ji)成。
通過(guò)以上工具和方法，您可以高效地構建專(zhuān)業(yè)化的┐(′д｀)┌文檔網(wǎng)站。根據項目需求選擇合適工具，并結合 Markdown 的簡(jiǎn)潔性和靜態(tài)網(wǎng)站的高性能特點(diǎn)，提升文檔展示效果。
Copyright ? 2012-2018 天津九安特機電工程有限公司 版權所有 備案號：
