一篇带你用 VuePress + Github Pages 搭建博客

简介: 最近完成了 TypeScript 最新官方文档 Hanbook 的翻译,一共十四篇,堪称国内的最好 TypeScript4 入门教程之一。为了方便大家阅读,我用 VuePress + Github Pages 搭建了博客。

0.png


前言


最近完成了 TypeScript 最新官方文档 Hanbook 的翻译,一共十四篇,堪称国内的最好 TypeScript4 入门教程之一为了方便大家阅读,我用 VuePress + Github Pages 搭建了博客,博客效果如下:


1.png


2.png


博客地址如下:



0. VuePress


VuePress 自然不用多说,基于 Vue 的静态网站生成器,风格简约,配置也比较简单。之所以不使用 VitePress,是因为想使用现有的主题, 而 VitePress 不兼容当前 VuePress 的生态系统,至于为什么不选择 VuePress@next,考虑到还处于 Beta 阶段,等稳定后再开始迁移。


1. 本地搭建


快速开始同 VuePress 官网


  1. 创建并进入一个新目录


// 文件名自定义
mkdir vuepress-starter && cd vuepress-starter
复制代码


  1. 使用你喜欢的包管理器进行初始化


yarn init # npm init
复制代码


  1. 将 VuePress 安装为本地依赖


yarn add -D vuepress # npm install -D vuepress
复制代码


  1. 创建你的第一篇文档,VuePress 会以 docs 为文档根目录,所以这个 README.md 相当于主页:


mkdir docs && echo '# Hello VuePress' > docs/README.md
复制代码


  1. 在 package.json 中添加一些 scripts


{
  "scripts": {
    "docs:dev": "vuepress dev docs",
    "docs:build": "vuepress build docs"
  }
}
复制代码


  1. 在本地启动服务器


yarn docs:dev # npm run docs:dev
复制代码


VuePress 会在 http://localhost:8080 (opens new window) 启动一个热重载的开发服务器。


2. 基础配置


在文档目录下创建一个 .vuepress 目录,所有 VuePress 相关的文件都会被放在这里。此时你的项目结构可能是这样:


.
├─ docs
│  ├─ README.md
│  └─ .vuepress
│     └─ config.js
└─ package.json
复制代码


.vuepress 文件夹下添加 config.js,配置网站的标题和描述,方便 SEO:


module.exports = {
  title: 'TypeScript4 文档',
  description: 'TypeScript4 最新官方文档翻译'
}
复制代码


此时界面类似于:


3.png


3. 添加导航栏


我们现在在页首的右上角添加导航栏,修改 config.js:


module.exports = {
    title: '...',
    description: '...',
    themeConfig: {
        nav: [
            { text: '首页', link: '/' },
            { 
                text: '冴羽的 JavaScript 博客', 
                items: [
                    { text: 'Github', link: 'https://github.com/mqyqingfeng' },
                    { text: '掘金', link: 'https://juejin.cn/user/712139234359182/posts' }
                ]
            }
        ]
    }
}
复制代码


效果如下:


4.png


更多的配置参考 VuePress 导航栏


4. 添加侧边栏


现在我们添加一些 md 文档,目前文档的目录如下:


.
├─ docs
│  ├─ README.md
│  └─ .vuepress
│     └─ config.js
|  └─ handbook
|     └─ ConditionalTypes.md
|     └─ Generics.md
└─ package.json
复制代码


我们在 config.js 配置如下:


module.exports = {
    themeConfig: {
        nav: [...],
        sidebar: [
            {
                title: '欢迎学习',
                path: '/',
                collapsable: false, // 不折叠
                children: [
                    { title: "学前必读", path: "/" }
                ]
            },
            {
              title: "基础学习",
              path: '/handbook/ConditionalTypes',
              collapsable: false, // 不折叠
              children: [
                { title: "条件类型", path: "/handbook/ConditionalTypes" },
                { title: "泛型", path: "/handbook/Generics" }
              ],
            }
          ]
    }
}
复制代码


对应的效果如下:


5.png


5. 更换主题


现在基本的目录和导航功能已经实现,但如果我还想要加载 loading、切换动画、模式切换(暗黑模式)、返回顶部、评论等功能呢,为了简化开发成本,我们可以直接使用主题,这里使用的主题是 vuepress-theme-rec


现在我们安装 vuepress-theme-reco:


npm install vuepress-theme-reco --save-dev
# or
yarn add vuepress-theme-reco
复制代码


然后在 config.js 里引用该主题:


module.exports = {
  // ...
  theme: 'reco'
  // ...
}  
复制代码


刷新一下页面,我们会发现一些细节的改变,比如加载时的 loading 动画、以及支持切换暗黑模式:


6.png


6. 添加文章信息


但我们也会发现,像条件类型这一篇文章,条件类型(Conditional Types) 竟然出现了两遍,这是因为这个主题自动提取了第一个大标题作为本文的标题,我们可以在每篇文章的 md 文件中添加一些信息修改:


---
title: 条件类型
author: 冴羽
date: '2021-12-12'
---
复制代码


此时文章的效果如下:


7.png


但如果你不想要标题、作者、时间这些信息呢,我们可以在样式里隐藏,这个稍后会讲到。


7. 设置语言


注意,上图的文章时间,我们写入的格式为 2021-12-12 ,但是显示的是 12/12/2021,这是因为  VuePress 默认的 lang 为 en-US,我们修改一下 config.js:


module.exports = {
  // ...
  locales: {
    '/': {
      lang: 'zh-CN'
    }
  },
  // ...
}  
复制代码


可以发现时间换了一种展示方式:


8.png


8. 开启目录结构


在原本的主题里,我们发现每篇文章的目录结构出现在左侧:


9.png


而 vuepress-theme-reco 将原有的侧边栏的中的多级标题移出,生成子侧边栏,放在了页面的右侧,如果你要全局开启,可在页面 config.js 里设置开启:


module.exports = {
  //...
  themeConfig: {
    subSidebar: 'auto'
  }
  //...
}
复制代码


此时效果如下:


10.png


9. 修改主题颜色


VuePress 基于 Vue,所以主题色用的是 Vue 的绿色,然而 TypeScript 的官方色则是蓝色,那如何修改 VuePress 的主题色呢?


你可以创建一个 .vuepress/styles/palette.styl 文件,文件代码如下:


$accentColor = #3178c6
复制代码


此时可以发现主题颜色变了:


11.png


更多的颜色修改参考 VuePress 的 palette.styl


10. 自定义修改样式


如果你想自定义修改一些 DOM 元素的样式呢?就比如在暗黑模式下:


12.png


我们发现用作强调的文字颜色比较暗淡,在暗黑模式下看不清楚,我想改下这个文字的颜色和背景色呢?


而 VuePress 提供了一种添加额外样式的简便方法。你可以创建一个 .vuepress/styles/index.styl 文件。这是一个 Stylus 文件,但你也可以使用正常的 CSS 语法。


我们在 .vupress 文件夹下创建这个目录,然后创建 index.styl 文件,代码如下:


// 通过检查,查看元素样式声明
.dark .content__default code {
    background-color: rgba(58,58,92,0.7);
    color: #fff;
}
复制代码


此时文字就清晰了很多:


13.png


那之前我们提到的隐藏每篇文章的标题、作者、时间呢,其实也是类似的方式:


.page .page-title {
   display: none;
}
复制代码


最后的效果如下:


14.png


11. 部署


我们的博客就算是正式的做好了,接下来我们部署到免费的 Github Pages 上。我们在 Github 上新建一个仓库,这里我取得仓库名为:learn-typescript


15.png


对应,我们需要在 config.js 添加一个 base 路径配置:


module.exports = {
    // 路径名为 "/<REPO>/"
    base: '/learn-typescript/',
    //...
}
复制代码


最终的 config.js 文件内容为:


module.exports = {
    title: 'TypeScript4 文档',
    description: 'TypeScript4 最新官方文档翻译',
    base: '/learn-typescript/',
    theme: 'reco',
    locales: {
        '/': {
          lang: 'zh-CN'
        }
    },
    themeConfig: {
        // lastUpdated: '上次更新',
        subSidebar: 'auto',
        nav: [
            { text: '首页', link: '/' },
            { 
                text: '冴羽的 JavaScript 博客', 
                items: [
                    { text: 'Github', link: 'https://github.com/mqyqingfeng' },
                    { text: '掘金', link: 'https://juejin.cn/user/712139234359182/posts' }
                ]
            }
        ],
        sidebar: [
            {
                title: '欢迎学习',
                path: '/',
                collapsable: false,
                children: [
                    { title: "学前必读", path: "/" }
                ]
            },
            {
              title: "基础学习",
              path: '/handbook/ConditionalTypes',
              collapsable: false,
              children: [
                { title: "条件类型", path: "/handbook/ConditionalTypes" },
                { title: "泛型", path: "/handbook/Generics" }
              ],
            }
          ]
    }
}
复制代码


然后我们在项目 vuepress-starter 目录下建立一个脚本文件:deploy.sh,注意修改一下对应的用户名和仓库名:


#!/usr/bin/env sh
# 确保脚本抛出遇到的错误
set -e
# 生成静态文件
npm run docs:build
# 进入生成的文件夹
cd docs/.vuepress/dist
git init
git add -A
git commit -m 'deploy'
# 如果发布到 https://<USERNAME>.github.io/<REPO>
git push -f git@github.com:mqyqingfeng/learn-typescript.git master:gh-pages
cd -
复制代码


然后命令行切换到 vuepress-starter 目录下,执行  sh deploy.sh,就会开始构建,然后提交到远程仓库,注意这里提交到了 gh-pages 分支,我们查看下对应仓库分支的代码:


16.png


我们可以在仓库的 Settings -> Pages 中看到最后的地址:


17.png


像我最后生成的地址就是 mqyqingfeng.github.io/learn-types…


至此,我们完成了 VuePress 和 Github Pages 的部署。


系列文章


系列文章目录地址:github.com/mqyqingfeng…


微信:「mqyqingfeng」,加我进冴羽唯一的读者群。


如果有错误或者不严谨的地方,请务必给予指正,十分感谢。如果喜欢或者 有所启发,欢迎 star,对作者也是一种鼓励。



目录
相关文章
|
7月前
|
Shell 网络安全 开发工具
Github Pages + Jekyll 独立博客一小时快速搭建&上线指南
Github Pages + Jekyll 独立博客一小时快速搭建&上线指南
|
2月前
|
JSON 缓存 JavaScript
使用 jsDelivr 免费加速 GitHub Pages 博客的静态资源(二)
使用 jsDelivr 加速 GitHub Pages 的图片资源和动态编译的 JSON 资源。
33 2
|
3月前
|
网络协议 开发工具 git
hexo github部署,通过域名访问你的博客
本文介绍了如何使用Hexo命令部署博客到GitHub,并详细说明了如何通过自定义域名访问GitHub上部署的博客。
hexo github部署,通过域名访问你的博客
|
2月前
为什么 GitHub Pages 的文章标题不能以 @ 开头?
本文记录了一个 GitHub Pages 博客网页上文章标题以 `@` 开头导致的问题,并分析了原因,提供了解决方法。
43 0
|
4月前
GitHub——使用GitHub Pages生成在线文档
GitHub——使用GitHub Pages生成在线文档
26 0
|
6月前
|
Web App开发 缓存 移动开发
四万字符数带你使用 Vitepress 构建博客并部署到 github 平台
四万字符数带你使用 Vitepress 构建博客并部署到 github 平台 最近写了好多篇 Chrome 浏览器插件相关的文章,有十几二十篇,就想着构建个博客,用来放置相应的文章。 正好前段时间看到 VitePress 1.0.0 发布了,而且是用 markdown 写文章,正好写插件文章的时候文章都是 md 格式,所有用下这个然后顺便写一篇使用教程。 Chrome 插件开发博客地址:https://18055975947.github.io/extension/
73 0
|
6月前
|
JavaScript 应用服务中间件 程序员
技术人如何利用 github+Jekyll ,搭建一个独立免费的技术博客
技术人如何利用 github+Jekyll ,搭建一个独立免费的技术博客
|
6月前
VitePress 构建的博客如何部署到 github 平台?
VitePress 构建的博客如何部署到 github 平台?
102 0
|
7月前
使用github制作个人网站或者博客
使用github制作个人网站或者博客
56 0
|
7月前
|
存储
github pages 部署单页面
github pages 部署单页面
121 0