手把手带你用 VuePress + Github Pages 搭建博客

5bc74e7b7ed25e494a019ae5a22bdd2a.png

博客地址:

  • Github https://mqyqingfeng.github.io/learn-typescript/

  • Gitee http://mqyqingfeng.gitee.io/learn-typescript/

点击 「阅读原文」,可直接访问,接下来我们看下具体搭建的步骤:

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 最新官方文档翻译’

}

此时界面类似于:

ea88c96f6ca28dc0c54ff58dd69d2a88.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’ }

]

}

]

}

}

效果如下:

e45570d5923f7ee58c55f5afd06b6606.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” }

],

}

]

}

}

对应的效果如下:

3bc012ee64b6daeed76ec86cf57071fa.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 动画、以及支持切换暗黑模式:

df0175dbbd8608931cbcb6ed56f58171.png

6. 添加文章信息


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


title: 条件类型

author: 冴羽

date: ‘2021-12-12’


此时文章的效果如下:

0b490841462fa87e807a31389de1c452.png

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

7. 设置语言


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

module.exports = {

// …

locales: {

‘/’: {

lang: ‘zh-CN’

}

},

// …

}

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

96e10b04c01279213bf200c1c1334ca0.png

8. 开启目录结构


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

b7c5f4b88d6b5753c62ccc4aa122259e.png

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

module.exports = {

//…

themeConfig: {

subSidebar: ‘auto’

}

//…

}

此时效果如下:

fb70e6bb90a0edc7759217d9a8fc2e17.png

9. 修改主题颜色


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

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

$accentColor = #3178c6

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

17cf2973a00a41c0152d6b5018c7281b.png

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

10. 自定义修改样式


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

自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。

深知大多数前端工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则几千的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!

因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。

img

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:前端)

更多面试题

**《350页前端校招面试题精编解析大全》**内容大纲主要包括 HTML,CSS,前端基础,前端核心,前端进阶,移动端开发,计算机基础,算法与数据结构,项目,职业发展等等

资料获取方式:点击蓝色传送门免费获取

自学提升又不知道该从何学起的朋友,同时减轻大家的负担。**

[外链图片转存中…(img-NmDwRy2c-1713837826770)]

[外链图片转存中…(img-HEfn4XRM-1713837826771)]

既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上前端开发知识点,真正体系化!

[外链图片转存中…(img-VYYc8Stg-1713837826771)]

由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!

如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:前端)

[外链图片转存中…(img-cAgROXLM-1713837826771)]

更多面试题

**《350页前端校招面试题精编解析大全》**内容大纲主要包括 HTML,CSS,前端基础,前端核心,前端进阶,移动端开发,计算机基础,算法与数据结构,项目,职业发展等等

资料获取方式:点击蓝色传送门免费获取

[外链图片转存中…(img-ik2L585U-1713837826771)]

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值