
作者:天津九安特機電工程有限公司 來(lái)源: 天津九安特機電工程有限公司 日期:2026-05-04 15:20:31
一、網(wǎng)站Docusaurus 搭建指南
1. 安裝與初始化
環(huán)境要求:需安裝 Node.js(版本≥14/16)
創(chuàng )建項目:運行命令 `npx create-docusaurus@latest my-website classic`(使用經(jīng)典主題模板)
啟動(dòng)開(kāi)發(fā)服務(wù)器:進(jìn)入項目目錄后執行 `npm star(???)t`,平臺訪(fǎng)問(wèn) `http://localhost:3000` 即可看到默認站點(diǎn)
2. 配置與自定義
基礎配置:編輯 `docusaurus.config.js`,搭建搭建檔網(wǎng)設置 `site_name`、個(gè)文`site_url`、網(wǎng)站導航菜(???)單等
高級功能:
國際化:內置多語(yǔ)言支持
部署:支持 GitH(′?_?`)ub Pages、平臺Netlify 等平臺一鍵部署
3. 文檔結構與主題
文檔存放:在 `docs` 目錄編寫(xiě) Mar??kdown 文件,搭建搭建檔網(wǎng)支持目錄導航
主題擴展:提供多種主題(如 `classic`、個(gè)文`readthedocs`),網(wǎng)站可通過(guò) `theme` 配置項切換
實(shí)時(shí)預覽:修改文檔后無(wú)需重新構建,平臺直接刷新瀏覽器即可更新
二、搭建搭建檔網(wǎng)MkDocs 搭建指南
1. 安裝與初始化
安裝工具:通過(guò) `pip install mkdocs` 安裝
創(chuàng )建項目:運行 `mkdocs new my_docs`,個(gè)文生成 `docs` 目錄及基礎配(???)置文件
啟動(dòng)開(kāi)發(fā)服務(wù)器:執行 `mkdoc??s serve`,網(wǎng)站訪(fǎng)問(wèn) `http://localhost:8000` 預覽站點(diǎn)
基礎配(???)置:編輯 `mkdocs.yml`,平臺設置 `site_name`、搭建搭建檔網(wǎng)`site_url`、導航菜單等
主題與插件(jian):
主題切換:支持 `readthedocs`、`alabaster` 等主題,可通過(guò) `theme` 配置項更換
插件擴展:集成代碼高亮(`docsify-copy-code`)、圖片縮放(`zoom-image`)等實(shí)用插件
動(dòng)態(tài)渲染:Markdown 文件修改后無(wú)需重新構建,實(shí)現實(shí)時(shí)更新
靜態(tài)站點(diǎn)托管:支持 GitHub Pages、Netlify 等平臺部署
與 GitBook 集成:可通過(guò) API 或插件實(shí)現與 GitBook 的雙向同步
三、選擇建議
Docusaurus:適合需要 React 組件、國際化或復雜交互的文檔網(wǎng)站,社區活躍且功能豐富???
根據項目需求選擇工具,若需進(jìn)一步定制,可參考官方文檔或社區示例。