一、網(wǎng)站(′_`)文檔網(wǎng)站使用 Docusauru( ?ω?)s搭建
特點(diǎn):Fac??ebook 開(kāi)源的平臺靜態(tài)網(wǎng)站生成器,基于 React 開(kāi)發(fā),搭建搭建支持 Markdown 編寫(xiě)文??檔,技(′▽?zhuān)?)術(shù)內置搜索、網(wǎng)站文檔網(wǎng)站國際化等功能,平臺主題豐富且可自定義。搭建搭建
步驟:
安裝 Node.js (需版本 ≥ 14)創(chuàng )建項目
```bash
npx create-docusaurus@latest my-website classic
``(′?`*)`
使用 `classic` 模板(適合技術(shù)文檔)
配置項目
修改 `docusaurus.config.js` 中的技術(shù)標題、描述等基本信息
添加 Markdown 文件到 `docs` 目錄
啟動(dòng)開(kāi)發(fā)服務(wù)器
```bash
npm start
```
訪(fǎng)問(wèn) `http://localhost:3000`(╬ ò﹏ó) 查看效果
部署
部署到 GitHub Pages 可自動(dòng)配置 HTTPS
或選擇其他靜態(tài)站點(diǎn)托管服務(wù)
二、網(wǎng)站文檔網(wǎng)站使用 Docsify搭建
特點(diǎn): 輕量級文檔??生成工具,平臺運行時(shí)轉換文檔,搭建搭建無(wú)需生成靜態(tài) HTML 文件,技術(shù)(′?ω?`)適合快速部署到 GitHub Pages,網(wǎng)站文檔網(wǎng)站支持插件擴展(zhan)。平臺 步驟安裝 Node.js
(需版本 ≥ 14)
全局安裝 Docsify CLI
```bash
npm i docsi(╥_╥)fy-cli -g
```
初始化項目
```bash
docsi┐(′д`)┌fy init ./do??cs
```
生成 `index.html`、搭建搭建`README.md` 等(deng)基礎文件
啟動(dòng)本(′?`)地服務(wù)器
```bash
docsify serve
訪(fǎng)問(wèn) `http://l┐(′д`)┌ocalhost:3000` 預覽
配置與部署
通過(guò) `index.html` 配置側邊欄??、插件等
部署至 GitHub Pages,支持自動(dòng) HTTPS 配置
三、其他選擇??方案
VuePress: 適合搭配 GitHub Actions 部署,支持 Markdown 和自定義??組件 CloudBase
靜態(tài)站點(diǎn)生成器:如 Jekyll(需配置 Gi??t)或 Hugo(需學(xué)習模板語(yǔ)法)
總結
Docusaurus 和 Docsify 都是快速搭建技術(shù)文檔網(wǎng)站的優(yōu)秀選擇。Docusaurus 功能更全面,適合需要復雜配置和主題定制的場(chǎng)景;Docsify 更輕量,適合簡(jiǎn)單部ヽ(′?`)ノ署和快速迭代。根據需求選擇合適工具,并結合 GitHub Pages 或其他托管服務(wù)即可。


網(wǎng)站二維碼
導航
電話(huà)
短信
咨詢(xún)
地圖
分享