要點:
1.用npm操作會有各種問題,用yarn取代之;
2.yarn可以用npm全局安裝,而npm是node環境自帶,node環境去官網下載安裝;
3.沒有必要全局安裝vuepress
操作:
1.新建一個空文件夾,這里我取名叫learn-vuepress,注意項目名不要寫成駝峰寫法(learnVuepress),因為在依賴項配置里面,這樣的項目名稱是不合法的。在項目目根目錄下新建名為docs的空文件夾,在docs文件夾內,再建一個.vuepress文件夾。結構如下:
如果不想這樣用命令行來建文件夾,那就手動來,也是一樣的。最后就是這樣子,三層結構。
2.初始化依賴配置表。也就是說初始化一個package.json。這里執行 yarn init -y。-y代表“yes”,也就是無詢問初始化配置表。
3.為項目的生產環境安裝vuepress。控制台運行yarn add -D vuepress@next。即為生產環境安裝vuepress,同時node_modules也會下載好,一步到位。
4.在package.json里面添加如下鍵值對:
"scripts": { "docs:dev": "vuepress dev docs", "docs:build": "vuepress build docs" }
這個鍵值對就很明顯地告訴我們:運行yarn run docs:dev,項目就可以跑起來了。
5.在docs根目錄下添加md文件,這是進入項目在沒有手動選擇任何路徑時,也就是處於/根路徑時的默認入口展示頁面。
6.在docs的根目錄再建模塊文件夾,模塊文件夾里面為具體的md文件,想取什么名字都行。
7.在每個md文件書寫相應的內容,都以一級標題開頭。
8.在.vuepress根目錄下新建public目錄,這通常用來存個favicon啥的,而config.js則是重頭戲了。
9.配置config.js
配置代碼截圖:
完整代碼:
module.exports = { title: '學習vuepress', //網站標題 base: '/', //打包后的base路徑 themeConfig: { //主題配置 head: [ ['link', { rel: 'icon', href: '/favicon.ico' }] //引入favicon ], search: false, //不要搜索框 sidebarDepth: 0, sidebar: [ //側邊欄 { title: '介紹', collapsable: false, children: [ '/' ] }, { title: '后端', collapsable: false, children: [ '/back-end/node.md' ] }, { title: '前端', collapsable: false, children: [ '/font-end/html.md', '/font-end/css.md', '/font-end/javascript.md' ] } ] } }
在sidebar的第一項中,我們引入了README.md文件,效果如下: