快捷導(dǎo)航

超詳細(xì)動(dòng)手搭建一個(gè)VuePress 站點(diǎn)及開啟PWA與自動(dòng)部署的方法

更新時(shí)間：2019年01月27日 10:26:01 作者：游魂Andy

這篇文章主要介紹了超詳細(xì)動(dòng)手搭建一個(gè)VuePress 站點(diǎn)及開啟PWA與自動(dòng)部署的方法，小編覺得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

五一之前就想寫一篇關(guān)于Vuepress的文章,結(jié)果朋友結(jié)婚就不了了之了。

記得最后一定要看注意事項(xiàng)！

Vuepress介紹

官網(wǎng)：https://vuepress.vuejs.org/

類似hexo一個(gè)極簡的靜態(tài)網(wǎng)站生成器,用來寫技術(shù)文檔不能在爽。當(dāng)然搭建成博客也不成問題。

Vuepress特點(diǎn)

響應(yīng)式,也可以自定義主題與hexo類似
內(nèi)置markdown(還增加了一些擴(kuò)展),并且可以在其使用Vue組件
Google Analytics 集成
PWA 自動(dòng)生成Service Worker

快速上手

安裝

初始化項(xiàng)目

yarn init -y
# 或者 npm init -y

安裝vuepress

yarn add -D vuepress
# 或者 npm install -D vuepress

全局安裝vuepress

yarn global add vuepress
# 或者 npm install -g vuepress

新建一個(gè)docs文件夾

mkdir docs

設(shè)置下package.json

{
 "scripts": {
  "docs:dev": "vuepress dev docs",
  "docs:build": "vuepress build docs"
 }
}

寫作

yarn docs:dev # 或者：npm run docs:dev

也就是運(yùn)行開發(fā)環(huán)境,直接去docs文件下書寫文章就可以,打開http://localhost:8080/可以預(yù)覽

構(gòu)建

build生成靜態(tài)的HTML文件,默認(rèn)會(huì)在 .vuepress/dist 文件夾下

yarn docs:build # 或者：npm run docs:build

基本配置

在 .vuepress 目錄下新建一個(gè) config.js ,他導(dǎo)出一個(gè)對象

一些配置可以參考官方文檔,這里我配置常用及必須配置的

網(wǎng)站信息

module.exports = {
 title: '游魂的文檔',
 description: 'Document library',
 head: [
  ['link', { rel: 'icon', href: `/favicon.ico` }],
 ],
}

導(dǎo)航欄配置

module.exports = {
 themeConfig: {
  nav: [
   { text: '主頁', link: '/' },
   { text: '前端規(guī)范', link: '/frontEnd/' },
   { text: '開發(fā)環(huán)境', link: '/development/' },
   { text: '學(xué)習(xí)文檔', link: '/notes/' },
   { text: '游魂博客', link: 'https://www.iyouhun.com' },
   // 下拉列表的配置
   {
    text: 'Languages',
    items: [
     { text: 'Chinese', link: '/language/chinese' },
     { text: 'English', link: '/language/English' }
    ]
   }
  ]
 }
}

如圖：

側(cè)邊欄配置

可以省略 .md 擴(kuò)展名,同時(shí)以 / 結(jié)尾的路徑將會(huì)被視為 */README.md

module.exports = {
 themeConfig: {
  sidebar: {
   '/frontEnd/': genSidebarConfig('前端開發(fā)規(guī)范'),
  }
 }
}

上面封裝的 genSidebarConfig 函數(shù)

function genSidebarConfig(title) {
 return [{
  title,
  collapsable: false,
  children: [
   '',
   'html-standard',
   'css-standard',
   'js-standard',
   'git-standard'
  ]
 }]
}

支持側(cè)邊欄分組(可以用來做博客文章分類) collapsable是當(dāng)前分組是否展開

module.exports = {
 themeConfig: {
  sidebar: {
   '/note': [
    {
     title:'前端',
     collapsable: true,
     children:[
      '/notes/frontEnd/VueJS組件編碼規(guī)范',
      '/notes/frontEnd/vue-cli腳手架快速搭建項(xiàng)目',
      '/notes/frontEnd/深入理解vue中的slot與slot-scope',
      '/notes/frontEnd/webpack入門',
      '/notes/frontEnd/PWA介紹及快速上手搭建一個(gè)PWA應(yīng)用',
     ]
    },
    {
     title:'后端',
     collapsable: true,
     children:[
      'notes/backEnd/nginx入門',
      'notes/backEnd/CentOS如何掛載磁盤',
     ]
    },
   ]
  }
 }
}

如圖：

默認(rèn)主題修改

主題色修改

在 .vuepress 目錄下的創(chuàng)建一個(gè) override.styl 文件

$accentColor = #3eaf7c // 主題色
$textColor = #2c3e50 // 文字顏色
$borderColor = #eaecef // 邊框顏色
$codeBgColor = #282c34 // 代碼背景顏色

自定義頁面類

有時(shí)需要在不同的頁面應(yīng)用不同的css,可以先在該頁面中聲明

---
pageClass: custom-page-class
---

然后在 override.styl 中書寫

.theme-container.custom-page-class {
 /* 特定頁面的 CSS */
}

PWA設(shè)置

設(shè)置serviceWorker為true,然后提供Manifest 和 icons,可以參考我之前的《PWA介紹及快速上手搭建一個(gè)PWA應(yīng)用》

module.exports = {
 head: [
  ['link', { rel: 'icon', href: `/favicon.ico` }],
  //增加manifest.json
  ['link', { rel: 'manifest', href: '/manifest.json' }],
 ],
 serviceWorker: true,
}

部署上線

設(shè)置基礎(chǔ)路徑

在 config.js 設(shè)置base 例如：你想要部署在https://foo.github.io 那么設(shè)置base為 / ,base默認(rèn)就為 / ,所以可以不用設(shè)置想要部署在https://foo.github.io/bar/,那么 base 應(yīng)該被設(shè)置成 "/bar/"

module.exports = {
 base: '/documents/',
}

base 將會(huì)自動(dòng)地作為前綴插入到所有以 / 開始的其他選項(xiàng)的鏈接中,所以你只需要指定一次。

構(gòu)建與自動(dòng)部署

用 gitHub 的pages或者coding的pages都可以,也可以搭建在自己的服務(wù)器上。將 dist 文件夾中的內(nèi)容提交到git上或者上傳到服務(wù)器就好

yarn docs:build # 或者：npm run docs:build

另外可以弄一個(gè)腳本,設(shè)置持續(xù)集成,在每次 push 代碼時(shí)自動(dòng)運(yùn)行腳本

deploy.sh

#!/usr/bin/env sh

# 確保腳本拋出遇到的錯(cuò)誤
set -e

# 生成靜態(tài)文件
npm run docs:build

# 進(jìn)入生成的文件夾
cd docs/.vuepress/dist

# 如果是發(fā)布到自定義域名
# echo 'www.example.com' > CNAME

git init
git add -A
git commit -m 'deploy'

# 如果發(fā)布到 https://<USERNAME>.github.io
# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master

# 如果發(fā)布到 https://<USERNAME>.github.io/<REPO>
git push -f git@github.com:<USERNAME>/<REPO>.git master:gh-pages

cd -

注意事項(xiàng)(坑)