最快用vuepress+github搭建一个博客

vuepress是vue提供的一个文档页生成工具,虽然官方还没有实现博客适配,但是现在可以通过一些小配置文件的修改,作为一个自己的博客生成工具

2.jpeg

事前准备

为了建立博客,我们需要一个存放博客页的地方,最理想的还是github啦

建立仓库

虽然现在github为每个仓库都提供了github pages服务,不过我们还是需要github提供的耳机线域名,所以

  1. 创建一个repository 这个repository的名字还有要求必须是<你的用户名>.github.io,像我就是mizuka-wu.github.io
  2. 申请域名和绑定ssl 在仓库的settings中Custom domain中可以填写自己的域名,当然直接在项目目录下建立CNAME文件填写自己的域名也可以,ssl可以使用certbot自主申请三个月的(三个月续期就可以无限使用了)
  3. 下载git,将这个git项目下载到本地吧

建立vuepress工作流

为什么使用?主要我觉得。。默认主题比较好看吧

基本环境搭建(npm)

  1. npm init(建立个package.json)
  2. https://www.gitignore.io/下载gitignore文件 推荐wget https://www.gitignore.io/api/node,webstorm+all,visualstudiocode -o .gitignore
  3. 建立blog文件夹(不用vuepress使用的doc因为我们不是建立文档

vuepress配置

vuepress生成依赖于.vuepress 当然使用默认配置也可以

我们最终是用vuepress构建我们写好的md文件,由于github.io相当于一个静态资源服务器,所以路径就变得很重要了, 所以配置上我们基本就是将本身的build路径改为根目录下的/post/ 然后将index.html这一类的资源构建完成后放入到根目录下

  • 增加vuepress npm i vuepress -D
  • 在blog文件夹下建立.vuepress文件夹 cd blog && mkdir .vuepress
  • .vuepress文件夹下建立config.js basePath保证输出位置和生成文件引用资源位置正确
const basePath = 'post'

module.exports = {
    // meta
    title: '我的博客', 
    description: '万事皆虚,万事皆允',
    // vuepress config
    dest: basePath,
    base: `/${basePath}/`,
    serviceWorker: true,
    evergreen: true,
    ga: 'UA-112738831-1'
}
  • package.json下增加script
  "scripts": {
    "dev": "vuepress dev blog",
    "build": "vuepress build blog",
  },
  • 构建结束后自动移动文件-我的方案是通过spwan写脚本,方便日后增加文件,如果嫌麻烦 直接build命令下增加&& cp post/index.html ./

推荐一个node可以使用es module的方案esm

/**
 * Build blog
 * @author Mizuka <mizuka.wu@outlook.com>
 */
import spawn from 'cross-spawn'
import { copyFile, writeFileSync } from 'fs'
import config from './blog/.vuepress/config'

const builder = spawn('vuepress', ['build', 'blog'])
builder.stdout.on('data', function (s) {
  console.log(s.toString())
})

builder.stdout.on('end', function () {
  if (config.postsAsRoot) {
    copyFile('post/index.html', 'index.html', (err) => {
      if (err) {
        console.error(err)
        throw err
      }
      console.log('copy /post/index.html to /')
    })
  }
})

开始编写吧!

剩下的只是在blog下按照自己的喜好编写markdown文件就好啦,构建完毕发布到github上看看呗

tip 一个主页以及显示所有文章

vuepress官方提供了一个主页生成的语法
这里说一下怎么显示所有的文档

vuepress支持在markdown中写vue!

vuepress提供了很多信息,比如$site.pages

在blog/README.md下增加一段vue代码

# 所有文章
<div style="display: flex; flex-direction: column">
    <div v-for="page of $site.pages.filter(item => item.path !== '/')" :key="page.key" style="padding: 20px 0; max-width: 33%;">
        <router-link :to="page.path">
            {{page.title}}
            <div style="color: #c2c5cd; font-size: .5rem;">{{(page.frontmatter.tags || ['无标签']).join(',  ')}}</div>
        </router-link>
    </div>
</div>

默认的工程文件可以来我的github博客直接下载呀~

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,510评论 25 707
  • 第一章 安装Git工具 下载GitHub for Windows,直接点击安装,安装完成后,可以看到“Git Sh...
    不圆的石头阅读 11,844评论 5 63
  • 转载http://www.cnblogs.com/bxm0927/p/6927340.html 大概流程: 1. ...
    阿de牧阅读 6,788评论 3 32
  • 1、早上本来在赶公交车,终于赶上了觉得自己挺幸运的,结果这事情没完,半路公交坏了,我第一想到要不叫一个滴滴,但是没...
    Wan9sha阅读 135评论 0 0
  • 这是我内心想写的一些故事,有一些不真实,有一些又是真实的。 她可能是你,也可能是我。 是我们身边好像不需要关心的那...
    昵小昵阅读 174评论 0 1