阅读 2946

手把手带你搭建VuePress的技术博客

先看效果图:

  • 首页

  • 评论区域

需要node环境和npm支持

如果不会安装npm请转到如何安装 npm 并管理 npm 版本

vuepress

这个还是蛮不错的,尤大出品,必属精品.

vuepress是什么?

  • Vue 驱动的静态网站生成器

  • 简洁至上 以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。

  • Vue驱动 享受 Vue + webpack 的开发体验,可以在 Markdown 中使用 Vue 组件,又可以使用 Vue 来开发自定义主题。

  • 高性能 VuePress 会为每个页面预渲染生成静态的 HTML,同时,每个页面被加载的时候,将作为 SPA 运行。

具体就不介绍了

详情请看官网vuepress

既然是手把手,当然我得一步一步下来

全局安装

npm install -g vuepress
复制代码

创建项目vuepess-blog

mkdir vuepress-blog
复制代码

项目初始化

npm init -y
复制代码

完了,会创建一个package.json

{
  "name": "vuepess-blog",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}
复制代码

其中添加主README.md文件

touch README.md
复制代码

在这个文件中主要写一些这是什么项目啊,这个项目有什么特性啊,这个项目怎么启动啊等等

# vuepress-blog
> a vuepress blog about qiufeihong

### Build Setup


# clone item
git clone git@github.com:qiufeihong2018/vuepress-blog.git

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run build

# deploy https://username.github.io
npm run d

# pm2 deploy
npm run server 


### main page
![avatar](./shotPic/main.png)

### feature
- [x] 可以统计阅读量
- [x] 支持评论
- [ ] Algolia搜索
- [ ] 在 GitHub 上编辑此页
- [ ] SEO


复制代码

添加docs文件夹

mkdir docs
复制代码

这个文件夹中主要放些你的配置和所写的博客内容

在docs文件夹中创建.vuepress文件夹

cd docs
mkdir .vuepress
复制代码

这个文件夹中你就可以放配置

新建总配置config.js文件

cd .vuepress
touch config.js
复制代码

主要配置都写在这里,我将侧边栏和导航懒配置抽离出来,实现模块化

module.exports = {
    title: '飞鸿的博客',
    description: '我的心路历程',
    dest: './dist',
    port: '7777',
    head: [
        ['link', {rel: 'icon', href: '/logo.gif'}]
    ],
    markdown: {
        lineNumbers: true
    },
    themeConfig: {
        nav: require('./nav'),
        sidebar: require('./sidebar'),
        sidebarDepth: 2,
        lastUpdated: 'Last Updated',
        searchMaxSuggestoins: 10,
        serviceWorker: {
            updatePopup: {
                message: "New content is available.",
                buttonText: 'Refresh'
            }
        },
        editLinks: true,
        editLinkText: '在 GitHub 上编辑此页 !'
    }
}

复制代码

新建导航栏nav.js

效果:

  1. 闭合

2. 展开

touch nav.js
复制代码

导航栏配置放在这个文件中

  1. 数组中的每个对象指的是每个导航标签;
  2. text就是导航标签名;
  3. link就是该文件的路径,docs是该路径的根目录,所以要‘/’开头。如果是外部链接,那就直接放进去即可。
  4. 导航标签下拉菜单,就要配置items,里面也是一个数组对象,同上。
module.exports = [
    {
        text: '首页', link: '/'
    },
    {
        text: '学习资源',
        items: [
            {text: '前端学习路线', link: 'http://www.imooc.com/article/261756'},
            {text: '前端学习视频', link: '/front-end-video/'},
            {text: '全栈', link: '/resource/'}
        ]
    },
    {
        text: '优文转载', link: '/reprint/'
    },
    {
        text: '技术总结',
        items: [
            {
                text: 'mongo', link: '/technical-summary/mongo/'
            },
            {
                text: 'vue-webpack', link: '/technical-summary/vue-webpack/'
            },
            {
                text: 'Vue.js 组件精讲', link: '/technical-summary/vue-component/'
            },
            {
                text: 'ubuntu', link: '/technical-summary/ubuntu/'
            },
            {
                text: 'eslint', link: '/technical-summary/eslint/'
            },
            {
                text: 'nuxt', link: '/technical-summary/nuxt/'
            },
            {
                text: 'node', link: '/technical-summary/node/'
            },
            {
                text: 'css', link: '/technical-summary/css/'
            },
            {
                text: 'github', link: '/technical-summary/github/'
            },
            {
                text: 'es6', link: '/technical-summary/es6/'
            }

        ]
    },
    {
        text: '视频总结', link: '/video-summary/'
    },
    {
        text: '面试', link: '/interview/'
    },
    {
        text: '优秀博客',
        items: [
            {
                text: '张鑫旭-鑫空间-鑫生活', link: 'https://www.zhangxinxu.com/'
            }
        ]
    },
    {
        text: '个人主页',
        items: [
            {
                text: 'GitHub', link: 'https://github.com/qiufeihong2018'
            },
            {
                text: '掘金', link: 'https://juejin.im/user/5bf4d63cf265da61561ee241/posts'
            },
            {
                text: 'CSDN', link: 'https://blog.csdn.net/weixin_38465623'
            },
            {
                text: 'segmentfault', link: 'https://segmentfault.com/u/qiufeihong2018'
            },
            {
                text: '知乎', link: 'https://www.zhihu.com/people/chou-fei-hong/activities'
            },
            {
                text: '简书', link: 'https://www.jianshu.com/'
            },
            {
                text: 'v2ex', link: 'https://www.v2ex.com/'
            }
        ]
    },
    {
        text: '那些年的电影', link: '/movie/'
    }
]

复制代码

当你们像我这样配置时,目录结构最好和我一样

目录结构如下:

创建侧边栏sidebar.js

效果:

侧边栏配置放在这里,将其他文件夹中的侧边栏配置引进来

module.exports = {
    '/technical-summary/github/': require('../technical-summary/github/sidebar'),
    '/technical-summary/vue-component/': require('../technical-summary/vue-component/sidebar'),
    '/interview/': require('../interview/sidebar'),
    '/reprint/':require('../reprint/sidebar')
}

复制代码

上述的具体文件的目录结构如下:

  • technical-summary

  • interview

  • reprint

在docs文件夹下面创建一个README.md文件

  • 默认的主题提供了一个首页,跟VuePress一样的主页

效果如下:


home: true
heroImage: /logo.jpg
actionText: 快速上手 →
actionLink: /zh/guide/
features:
- title: 简洁至上
  details: 以 Markdown 为中心的项目结构,以最少的配置帮助你专注于写作。
- title: Vue驱动
  details: 享受 Vue + webpack 的开发体验,在 Markdown 中使用 Vue 组件,同时可以使用 Vue 来开发自定义主题。
- title: 高性能
  details: VuePress 为每个页面预渲染生成静态的 HTML,同时在页面被加载的时候,将作为 SPA 运行。
footer: MIT Licensed | Copyright © 2018-present Evan You

复制代码
  • 也可以像我这样配置:你可以将首页图片换成gif格式的,骚一点

效果如下:

---
home: true
heroImage: /logo-computed.gif
actionText: 是时候展现真正的技术了 →
actionLink: /resource/
features:
- title:  比尔·盖茨经典语录/名句
  details: 只要有坚强的持久心,一个庸俗平凡的人也会有成功的一天,否则即使是一个才识卓越的人,也只能遭遇失败的命运。

- title: 乔布斯经典语录/名句
  details: 你的时间有限,所以不要为别人而活。不要被教条所限,不要活在别人的观念里。不要让别人的意见左右自己内心的声音。最重要的是,勇敢的去追随自己的心灵和直觉,只有自己的心灵和直觉才知道你自己的真实想法,其他一切都是次要。

- title: 李嘉诚经典语录/名句
  details: 当你放下面子赚钱的时候,说明你已经懂事了。当你用钱赚回面子的时候,说明你已经成功了。当你用面子可以赚钱的时候,说明你已经是人物了。当你还停留在那里喝酒、吹牛,啥也不懂还装懂,只爱所谓的面子的时候,说明你这辈子也就这样了。

footer: MIT Licensed | Copyright © 2019-present FeiHong
---

### 12345
```bash
# clone item
git clone git@github.com:qiufeihong2018/vuepress-blog.git

# install dependencies
npm install 

# serve with hot reload at localhost:6666
npm run dev

# build for production with minification
npm run build

# deploy to github page
npm run d

# build&&pm2
npm run server


::: warning 注意

请确保你的 Node.js 版本 >= 8。
:::

复制代码

现在就可以在docs文件夹中写博客内容了

我就举一个最简单的例子

  1. 创建front-end-video文件,在文件夹中创建README.md,这里面写博客啦
mkdir front-end-video
cd front-end-video
touch README.md
复制代码
###  前端学习
技术博客

复制代码

在package.json中添加启动命令

  1. 启动项目:npm run dev 这条命令就等于vuepress dev docs
  2. 打包项目:npm run build 这条命令就等于vuepress build docs
{
  "name": "vuepress-blog",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "dev": "vuepress dev docs",
    "build": "vuepress build docs",
    "server": "npm run build && pm2 start blog.js",
    "d": "bash deploy.sh"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@vuepress/plugin-back-to-top": "^1.0.0-alpha.0",
    "element-ui": "^2.5.4",
    "express": "^4.16.4",
    "leancloud-storage": "^3.12.0",
    "pm2": "^3.2.9",
    "valine": "^1.3.4",
    "vuepress": "^0.14.9"
  }
}

复制代码

你的项目就run起来了

推送到远程仓库

  1. 在GitHub中新建仓库
  2. 在根目录下添加.gitignore忽略一些文件
  3. 推送上去
node_modules
dist
.idea
复制代码
git init

git add .

git commit -m "my first push vuepess blog"

git push

复制代码

挂载到GitHub Pages

  1. 在根目录中创建脚本deploy.sh

这里的'#'是注释

  1. 然后打开你的github仓库,再建一个仓库
  2. 将下列第20行中我的仓库名替换成你的仓库名
  3. 在package.json中添加命令npm run d,这条命令就是bash deploy.sh,这条命令的意思是启动这个脚本
  4. 你的vueress的博客就成功挂载GitHub Pages上了
###!/usr/bin/env sh

### 确保脚本抛出遇到的错误
set -e

### 生成静态文件
npm run build

### 进入生成的文件夹
cd dist

### 如果是发布到自定义域名
### echo 'www.yourwebsite.com' > CNAME

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

### 如果你想要部署到 https://USERNAME.github.io
git push -f git@github.com:qiufeihong2018/qiufeihong2018.github.io.git master

### 如果发布到 https://USERNAME.github.io/<REPO>  REPO=github上的项目
### git push -f git@github.com:USERNAME/<REPO>.git master:gh-pages

cd -
复制代码

完了后,就可以qiufeihong2018.github.io/访问了

pm2守护程序

效果自行脑补,后台一直运行

  1. 安装pm2,将其写进package.json中
npm install -save pm2
复制代码

用到express,所以你得先安装一下 npm install -save express

  1. 根文件中添加pm2脚本blog.js
const fs = require('fs');
const path = require('path');
const express = require('express');
const chalk = require('chalk')
const blog = express();
blog.use(express.static(path.resolve(__dirname, './dist')))

blog.get('*', function(req, res) {
    const html = fs.readFileSync(path.resolve(__dirname, './dist/index.html'), 'utf-8')
    res.send(html)
})
blog.listen(7777, res => {
    console.log(chalk.yellow('Start Service On 7777'));
});

复制代码
  1. 添加启动命令

npm run server:这条命令是npm run build && pm2 start blog.js,意思是打包并且启动pm2

想要知道更多pm2操作,请移步pm2

添加valine评论和阅读量统计

效果如下:

  1. 安装valine模块
npm install -save valine
复制代码
  1. 在.vuepress中创建components文件夹,在其中创建Valine组件
<template>
    <div class="page">
        <section class="page-edit">
            <div>
                <!-- id 将作为查询条件 -->
                <span class="leancloud-visitors"
                      data-flag-title="Your Article Title">
        <em class="post-meta-item-text">阅读量: </em>
        <i class="leancloud-visitors-count"></i>
      </span>
            </div>
            <h3>
                <a href="javascript:;"></a>
                评 论:
            </h3>
            <div id="vcomments"></div>
        </section>
    </div>

</template>

<script>
    export default {
        name: 'Valine',
        mounted: function () {
            // require window
            const Valine = require('valine');
            if (typeof window !== 'undefined') {
                this.window = window
                window.AV = require('leancloud-storage')
            }
            this.valine = new Valine()
            this.initValine()
        },
        watch: {
            $route (to, from) {
                if (from.path != to.path) {
                    this.initValine()
                }
            }
        },
        methods: {
            initValine () {
                let path = location.origin + location.pathname
                // vuepress打包后变成的HTML不知为什么吞掉此处的绑定`:id="countId"`
                document.getElementsByClassName('leancloud-visitors')[0].id = path
                this.valine.init({
                    el: '#vcomments',
                    appId: '********',// your appId
                    appKey: '********', // your appKey
                    notify: false,
                    verify: false,
                    path: path,
                    visitor: true,
                    avatar: 'mm',
                    placeholder: 'write here'
                });
            }
        }
    }
</script>
复制代码
  1. 修改其中的appId和appKey
  2. 获取APP ID 和 APP Key,请先登录或注册 LeanCloud, 进入控制台后点击左下角创建应用
  3. 在.vuepress中创建theme文件夹
  4. 将node_modules中的Layout拷贝到theme文件夹中

  1. 将引用的文件路径改成指向node_modules去
    import Vue from 'vue'
    import nprogress from 'nprogress'
    import Home from '../../../node_modules/vuepress/lib/default-theme/Home.vue'
    import Navbar from '../../../node_modules/vuepress/lib/default-theme/Navbar.vue'
    import Page from '../../../node_modules/vuepress/lib/default-theme/Page.vue'
    import Sidebar from '../../../node_modules/vuepress/lib/default-theme/Sidebar.vue'
    import SWUpdatePopup from '../../../node_modules/vuepress/lib/default-theme/SWUpdatePopup.vue'
    import {resolveSidebarItems} from '../../../node_modules/vuepress/lib/default-theme/util'
    import Valine from '../components/Valine'
复制代码
  1. 在Layout中添加valine
<template>
    <div
            class="theme-container"
            :class="pageClasses"
            @touchstart="onTouchStart"
            @touchend="onTouchEnd"
    >
        <Navbar
                v-if="shouldShowNavbar"
                @toggle-sidebar="toggleSidebar"
        />

        <div
                class="sidebar-mask"
                @click="toggleSidebar(false)"
        ></div>

        <Sidebar
                :items="sidebarItems"
                @toggle-sidebar="toggleSidebar"
        >
            <slot
                    name="sidebar-top"
                    slot="top"
            />
            <slot
                    name="sidebar-bottom"
                    slot="bottom"
            />
        </Sidebar>

        <div
                class="custom-layout"
                v-if="$page.frontmatter.layout"
        >
            <component :is="$page.frontmatter.layout"/>
        </div>

        <Home v-else-if="$page.frontmatter.home"/>

        <Page
                v-else
                :sidebar-items="sidebarItems"
        >
            <slot
                    name="page-top"
                    slot="top"
            />
            <slot
                    name="page-bottom"
                    slot="bottom"
            />
        </Page>
        <Valine></Valine>

        <SWUpdatePopup :updateEvent="swUpdateEvent"/>
    </div>
</template>
复制代码
  1. 大功告成

目前暂不支持首页去除,每个页面最底下都有

想要知道更多Valine操作,请移步Valine

导航栏分类小技巧

效果图

如图,优秀博客分为个人博客和团队博客两大类,实验证明,items是可以一直items下去的,所以可以分得很细

    {
        text: '优秀博客',
        items: [
            {
                text: '个人博客',
                items: [
                    {
                        text: '张鑫旭-鑫空间-鑫生活', link: 'https://www.zhangxinxu.com/'
                    },
                    {
                        text: 'Cherry\'s Blog', link: 'https://cherryblog.site/'
                    },
                    {
                        text: 'ECMAScript 6 入门', link: 'http://es6.ruanyifeng.com/'
                    }
                ]
            },
            {
                text: '团队博客',
                items: [

                    {
                        text: '美团技术博客', link: 'https://tech.meituan.com/'
                    },
                    {
                        text: '百度前端fex', link: 'http://fex.baidu.com/'
                    },
                    {
                        text: '淘宝前端团队FED', link: 'http://taobaofed.org/'
                    },
                    {
                        text: '腾讯CDC', link: 'https://cdc.tencent.com/'
                    },
                    {
                        text: '京东JDC', link: 'https://jdc.jd.com/'
                    },
                    {
                        text: '携程设计委员会Ctrip Design Committee', link: 'http://ued.ctrip.com/'
                    },
                    {
                        text: '腾讯全端AlloyTeam', link: 'http://www.alloyteam.com/2018/12/13440/'
                    }
                ]
            }
        ]
    },

复制代码

其余配置

Markdown 拓展

参考文献

VuePress 手把手教你搭建一个类Vue文档风格的技术文档/博客

手把手教你使用 VuePress 搭建个人博客

vuepress和valine搭建带评论的博客

最后,别忘了给这个项目点一个star哦,谢谢支持。

blog

一个学习编程技术的公众号。每天推送高质量的优秀博文、开源项目、实用工具、面试技巧、编程学习资源等等。目标是做到个人技术与公众号一起成长。欢迎大家关注,一起进步,走向全栈大佬的修炼之路

关注下面的标签,发现更多相似文章
评论