vuepress2.0使用教程(1) - 搭建項(xiàng)目

介紹

VuePress 是一個(gè)以 Markdown 為中心的靜態(tài)網(wǎng)站生成器。你可以使用 Markdown在新窗口打開(kāi) 來(lái)書(shū)寫(xiě)內(nèi)容(如文檔、博客等),然后 VuePress 會(huì)幫助你生成一個(gè)靜態(tài)網(wǎng)站來(lái)展示它們。

VuePress 誕生的初衷是為了支持 Vue.js 及其子項(xiàng)目的文檔需求,但是現(xiàn)在它已經(jīng)在幫助大量用戶(hù)構(gòu)建他們的文檔、博客和其他靜態(tài)網(wǎng)站。

依賴(lài)環(huán)境(優(yōu)先檢查,否則后續(xù)會(huì)報(bào)錯(cuò))

手動(dòng)安裝

? 步驟 1: 創(chuàng)建并進(jìn)入一個(gè)新目錄

mkdir blog
cd blog
  • 步驟 2: 初始化項(xiàng)目
git init
npm init //這個(gè)時(shí)候會(huì)出現(xiàn)一堆選項(xiàng),沒(méi)有特殊要求直接回車(chē)默認(rèn)就行
  • 步驟 3: 將 VuePress 安裝為本地依賴(lài)
npm install -D vuepress@next @vuepress/client@next vue
  • 步驟 4: 在 package.json 中添加一些 script
{
  "scripts": {
    "dev": "vuepress dev docs",
    "build": "vuepress build docs"
  }
}
Untitled
  • 步驟 5: 將默認(rèn)的臨時(shí)目錄和緩存目錄添加到 .gitignore 文件中
echo 'node_modules' >> .gitignore
echo '.temp' >> .gitignore
echo '.cache' >> .gitignore
  • 步驟 6: 創(chuàng)建你的第一篇文檔
mkdir docs
echo '# Hello VuePress' > docs/README.md

稍微解釋一下:為什么是README.md文件?vuepress默認(rèn)認(rèn)為一個(gè)目錄的默認(rèn)文檔是index.md或者README.md,既然這是網(wǎng)站首頁(yè),那就是要去尋找當(dāng)前目錄下的index.md或者README.md,你可以嘗試把README.md改成index.md是一樣的效果,但是改成doc1.md就會(huì)報(bào)404

? 步驟 7: 在本地啟動(dòng)服務(wù)器來(lái)開(kāi)發(fā)你的文檔網(wǎng)站

npm run dev
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容