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

介紹

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

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

依賴環(huán)境(優(yōu)先檢查样漆,否則后續(xù)會報錯)

手動安裝

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

mkdir blog
cd blog
  • 步驟 2: 初始化項目
git init
npm init //這個時候會出現(xiàn)一堆選項为障,沒有特殊要求直接回車默認(rèn)就行
  • 步驟 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: 將默認(rèn)的臨時目錄和緩存目錄添加到 .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)為一個目錄的默認(rèn)文檔是index.md或者README.md放祟,既然這是網(wǎng)站首頁鳍怨,那就是要去尋找當(dāng)前目錄下的index.md或者README.md,你可以嘗試把README.md改成index.md是一樣的效果舞竿,但是改成doc1.md就會報404

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

npm run dev
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末京景,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子骗奖,更是在濱河造成了極大的恐慌确徙,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,252評論 6 516
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件执桌,死亡現(xiàn)場離奇詭異鄙皇,居然都是意外死亡,警方通過查閱死者的電腦和手機仰挣,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,886評論 3 399
  • 文/潘曉璐 我一進店門伴逸,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人膘壶,你說我怎么就攤上這事错蝴≈薹撸” “怎么了?”我有些...
    開封第一講書人閱讀 168,814評論 0 361
  • 文/不壞的土叔 我叫張陵顷锰,是天一觀的道長柬赐。 經(jīng)常有香客問我,道長官紫,這世上最難降的妖魔是什么肛宋? 我笑而不...
    開封第一講書人閱讀 59,869評論 1 299
  • 正文 為了忘掉前任,我火速辦了婚禮束世,結(jié)果婚禮上酝陈,老公的妹妹穿的比我還像新娘。我一直安慰自己毁涉,他們只是感情好沉帮,可當(dāng)我...
    茶點故事閱讀 68,888評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著贫堰,像睡著了一般遇西。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上严嗜,一...
    開封第一講書人閱讀 52,475評論 1 312
  • 那天,我揣著相機與錄音洲敢,去河邊找鬼漫玄。 笑死,一個胖子當(dāng)著我的面吹牛压彭,可吹牛的內(nèi)容都是我干的睦优。 我是一名探鬼主播,決...
    沈念sama閱讀 41,010評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼壮不,長吁一口氣:“原來是場噩夢啊……” “哼汗盘!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起询一,我...
    開封第一講書人閱讀 39,924評論 0 277
  • 序言:老撾萬榮一對情侶失蹤隐孽,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后健蕊,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體菱阵,經(jīng)...
    沈念sama閱讀 46,469評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,552評論 3 342
  • 正文 我和宋清朗相戀三年缩功,在試婚紗的時候發(fā)現(xiàn)自己被綠了晴及。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,680評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡嫡锌,死狀恐怖虑稼,靈堂內(nèi)的尸體忽然破棺而出琳钉,到底是詐尸還是另有隱情,我是刑警寧澤蛛倦,帶...
    沈念sama閱讀 36,362評論 5 351
  • 正文 年R本政府宣布歌懒,位于F島的核電站,受9級特大地震影響胰蝠,放射性物質(zhì)發(fā)生泄漏歼培。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 42,037評論 3 335
  • 文/蒙蒙 一茸塞、第九天 我趴在偏房一處隱蔽的房頂上張望躲庄。 院中可真熱鬧,春花似錦钾虐、人聲如沸噪窘。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,519評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽倔监。三九已至,卻和暖如春菌仁,著一層夾襖步出監(jiān)牢的瞬間浩习,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,621評論 1 274
  • 我被黑心中介騙來泰國打工济丘, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留谱秽,地道東北人。 一個月前我還...
    沈念sama閱讀 49,099評論 3 378
  • 正文 我出身青樓摹迷,卻偏偏與公主長得像疟赊,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子峡碉,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,691評論 2 361

推薦閱讀更多精彩內(nèi)容