VuePress是基于Vue生態的靜態網站生成器,能夠快速創建文檔站點,并且提供了自動生成側邊欄和導航欄的能力,可以快速、方便地生成風格簡潔、易于閱讀的文檔站點。
要使用VuePress,在項目中需要先安裝vuepress包。可以使用npm安裝。
npm install -D vuepress
一旦安裝完成,就可以為項目編寫自己的文檔了。在項目根目錄下創建docs文件夾,docs文件夾中創建README.md文件。README.md文件即為文檔站點的主頁。
mkdir docs
cd docs
touch README.md
接下來,在package.json文件中為VuePress添加一個啟動命令。
{
"scripts": {
"docs:dev": "vuepress dev docs"
}
}
執行npm run docs:dev后,在http://localhost:8080/上就可以看到VuePress文檔站點的主頁了。
接下來就可以在docs文件夾中添加其他的文檔文件。VuePress會根據路徑自動生成側邊欄和導航欄。例如,如果在docs中新增一個getting-started.md文件,則可以在主頁的左側看到導航欄中新增了一個“Getting Started”選項。同理,在getting-started.md文件中添加子標題,也會自動生成側邊欄。
# Install
## npm
\`\`\`bash
npm install -g vuepress
\`\`\`
## Yarn
\`\`\`bash
yarn global add vuepress
\`\`\`
通過使用如上的HTML代碼和CSS樣式,下面的效果會在文檔站點中出現一個安裝VuePress的代碼塊,且代碼塊中每一行代碼都有不同的高亮色。
經過以上步驟之后,一個基礎的VuePress文檔站點就建立好了。接下來可以根據需要增加更多功能,例如添加搜索、添加Google Analytics、添加自定義主題等等。VuePress提供了很多擴展的功能,具體可以參考官方文檔。
上一篇vue中保存本地
下一篇python 登錄與注冊