欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Vuepress 搭建带评论功能的静态博客的实现

程序员文章站 2022-05-25 18:46:27
vuepress 是 vue 驱动的静态站点生成工具 本文仅介绍,搭建静态博客的过程,具体教程及文档请点击进入 vuepress初始化 下面初始化...

vuepress 是 vue 驱动的静态站点生成工具

本文仅介绍,搭建静态博客的过程,具体教程及文档请点击进入

vuepress初始化

下面初始化

# 将 github 新创建的仓库克隆到本地
git clone git@github.com:zhb333/readme-blog.git

# 进入项目
cd readme-blog

# npm 初始化, 按照提示回车
npm init

# 安装 vuepress
npm i vuepress -d

# 安装 gh-pages
npm i gh-pages -d

# 创建一个 docs 目录
mkdir docs

# 创建一个 markdown 文件
echo '# hello vuepress' > docs/readme.md

npm 脚本

然后,给 package.json 添加一些 scripts 脚本:

{
 "scripts": {
  "dev": "vuepress dev docs",
  "build": "vuepress build docs",
  "deploy": "npm run build && gh-pages -d docs/.vuepress/dist"
 }
}

运行本地开发环境

运行 vurepress 的本地开发环境

npm run dev

访问 localhost:8080 , 已经成功开启

基础配置

生成静态资源

执行下面的命令,生成静态资源

npm run build

默认情况下,构建的文件会位于 docs/.vuepress/dist 中,该文件可以通过 docs/.vuepress/config.js 中的 dest 字段进行配置。

配置

创建 docs/.vuepress/config.js, 并进行简单配置

var config = {

 // 静态网站部署的目录
 base: '/readme-blog/',

 // 网站标题
 title: '标 の 博客',

 // <meta name="description" content="...">
 description: '种一棵树最好的时间是十年前,其次是现在', 

 markdown: {
  
  // 显示代码行号
  linenumbers: true
 }
}

module.exports = config

博客首页

公共文件

创建 docs/.vuepress/public 用于存放公共文件

我在 public/ , 存在了 favicon.ico 图标, 以及 zlx.jpg 首页的头像图片

简单的首页编写

将 docs/readme.md设置为首页, 修改代码为:

---
home: true
heroimage: /zlx.jpg
footer: mit licensed | copyright © 2018 zhanghuanbiao
---

设置网站 ico 图标

配置网站的 ico 图标, 修改 .vuepress/config.js:

const config = {
 head: [
  ['link', { rel: 'icon', href: '/favicon.ico' }]
 ]
}

导航栏

配置导航栏

使用 vuepress 的默认主题配置导航栏 .vuepress/config.js:

const nav = [
 {
  text: '前端栈',
  items: [
   { text: 'vue', link: '/web/vue/vuepress-blog' },
   { text: 'react', link: '/web/react/react-router' }
  ]
 }
]

const config = {
 themeconfig: {

  // 项目的 github 地址
  repo: 'zhb333/readme-blog',

  // github 地址的链接名
  repolabel: '代码',

  // 配置导航栏
  nav,
 },
}

创建有效的导航资源

为了使得导航栏的链接点击有效, 我们创建两个文件:

docs/web/vue/vuepress-blog.md

# 使用`vuepress`搭建静态博客
## vuepress初始化
## 基础配置
## 博客首页
## 导航栏

docs/web/react/react-router.md

# react-router

侧边栏

侧边栏配置

使用 vuepress 的默认主题配置侧边栏 .vuepress/config.js:

const sidebar = {
 '/web/': [
  {
   title: 'vue',
   children: [
    'vue/vuepress-blog'
   ]
  },

  {
   title: 'react',
   children: [
    'react/react-router'
   ]
  }
 ]
}

const nav = [
 {
  text: '前端栈',
  items: [
   { text: 'vue', link: '/web/' + sidebar['/web/'][0]['children'][0] },
   { text: 'react', link: '/web/' + sidebar['/web/'][1]['children'][0] }
  ]
 }
]

var config = {
 themeconfig: {

  // 当前 markdown 的 github 代码链接
  editlinks: true,

  // 链接显示的文本
  editlinktext: '查看原文|编辑此页',

  nav,
  sidebar,
 },
}

侧边栏效果

访问: http://localhost:8080/readme-blog/web/vue/vuepress-blog.html, 可以看到侧边栏已经生成

将静态博客网站部署到外网

使用 gh-pages 进行项目部署

npm run deploy

过几分钟后,访问 https://zhb333.github.io/readme-blog/, 便可以看到在外网成功部署的静态博客

评论功能

我们使用 valine 来实现评论功能:

valine - 一款快速、简洁且高效的无后端评论系统。

点击进入 valine官网 ,需要先注册才能食用

安装 valine

# install leancloud's js-sdk
npm install leancloud-storage --save

# install valine
npm install valine --save

注册 vuepress 全局组件

创建 .vuepress/components/valine.vue

<template>
 <div id="vcomments"></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')
   
  }
   
  new valine({
   el: '#vcomments' ,
   appid: '',// your appid
   appkey: '', // your appkey
   notify:false, 
   verify:false, 
   avatar:'mm', 
   placeholder: 'just go go' 
  });
 },
}
</script>

使用 valine

只需要在 markdown 中调用即可

<valine></valine>

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。