介紹
VuePress 是一個以 Markdown 為中心的靜態網站生成器。你可以使用 Markdown在新窗口打開 來書寫內容(如文檔、博客等),然后 VuePress 會幫助你生成一個靜態網站來展示它們。
VuePress 誕生的初衷是為了支持 Vue.js 及其子項目的文檔需求,但是現在它已經在幫助大量用戶構建他們的文檔、博客和其他靜態網站。
依賴環境(優先檢查,否則后續會報錯)
手動安裝
? 步驟 1: 創建并進入一個新目錄
mkdir blog
cd blog
- 步驟 2: 初始化項目
git init
npm init //這個時候會出現一堆選項,沒有特殊要求直接回車默認就行
- 步驟 3: 將 VuePress 安裝為本地依賴
npm install -D vuepress@next @vuepress/client@next vue
-
步驟 4: 在
package.json
中添加一些 script
{
"scripts": {
"dev": "vuepress dev docs",
"build": "vuepress build docs"
}
}
Untitled
-
步驟 5: 將默認的臨時目錄和緩存目錄添加到
.gitignore
文件中
echo 'node_modules' >> .gitignore
echo '.temp' >> .gitignore
echo '.cache' >> .gitignore
- 步驟 6: 創建你的第一篇文檔
mkdir docs
echo '# Hello VuePress' > docs/README.md
稍微解釋一下:為什么是README.md文件?vuepress默認認為一個目錄的默認文檔是index.md或者README.md,既然這是網站首頁,那就是要去尋找當前目錄下的index.md或者README.md,你可以嘗試把README.md改成index.md是一樣的效果,但是改成doc1.md就會報404
? 步驟 7: 在本地啟動服務器來開發你的文檔網站
npm run dev