快速搭建你的 github pages 个人博客——基于 Create-React-App 的单页面应用实践

相信各位github资深玩家们都有自己基于 搭建的个人站点。官方推荐的静态站点生成器是 ,关于 的使用感兴趣的各位请自行 google,这里就不赘述了。本文主要介绍下基于 搭建个人博客的相关实践,可能更适合做前端开发的伙伴。

是 推出的静态站点服务,主要的用途在于使用你在 仓库中的代码构建你自己的静态站点,为用户提供 二级域名,您也可以通过添加DNS的 记录来绑定自己的域名。

最简单粗暴的方法就是直接往 github 上方静态页面了,创建一个名为 的github仓库,将您的index.html页面代码扔进master分支,就可以直接通过 访问到您的站点了。

对于一个简单的个人博客站点来说,存在以下基本功能特性:

文章的新增、编辑、一键发布

文章的分类、归档yarn

风格良好的博客样式

评论、SEO等功能

下面介绍基于React如何实现一个简单的静态博客。

1. 创建一个 React 项目

使用 Create-React-App(以下简称CRA) 的generator创建一个React前端项目骨架。对此项目进行一定改造以方便我们日常的开发和使用习惯:

使用 来调整CRA中webpack的配置

对CRA的webpack配置感兴趣的童鞋可以看看这篇文章

使用 对浏览器版本进行向下兼容

通过编写不同的React容器组件(container)来实现不同的页面,通过统一的json结构来配置应用的页面路由

使用蚂蚁金服的 设计语言(React组件)快速实现业务UI

使用 实现前后端的数据请求

个人改造后的项目代码在这里,您可以直接fork或者down下来使用。

2. 使用 markdown 搞定你的文章2.1 用于新建文章的交互式命令行(基于 inquirer)

一般的静态博客系统(如gatsby),会给用户提供一个用于创建新文章的交互式命令行,效果大致如下:

类似功能可以使用nodejs中readline模块的原生方法来实现。这里推荐一个第三方工具:inquirer,本质上是对readline模块进行了增强,提供了很多实用的方法用于交互式命令行开发,实现的用户界面(命令行)也比较友好。

对于上面GIF示例的功能,其代码实现如下:

如是,将此node脚本添加到项目 的 中(如: ),即可通过 命令运行。

2.2 md 转 html(基于 react-markdown)

为使用markdown文档来编辑、存储博客的文章内容,需要将md文档内容转换为react的JSX对象以渲染到网页中。在此推荐使用react-markdown,功能很6,作者维护得也比较勤。

使用方式如下:

2.3 代码块的语法高亮

react-markdown提供了一个renderers属性,用户可以传入一系列renderer组件来自定义文章中一些内容的渲染方式(有兴趣的童鞋可以看下包作者对默认renderer的实现)。

如:自定义md中图片的渲染方式(用法如下)。

与此类似,我们可以通过传入一个自定义的renderer来实现文章中代码块的语法高亮。名为 的renderer实现如下:

此处用到了prismjs和react-html-parser两个npm包,前者用于将代码文本转化为html文本,后者用于将html文本转化为React的JSX对象以传入React组件(这样做比直接使用dangerouslySetInnerHTML属性更安全些)。

3. 文章分类

一个友好的站点肯定少不了导航菜单(或文章的分类菜单),本人的实现方式是直接使用文章的“标签”来进行分类统计,并生成站点的顶部导航,效果如下:

为此,需要撰写一定的脚本实现文章的分类统计和打包,个人的实现方式是将统计结果和文章内容各自打包为json文件,通过前端组件请求数据并加载。

导航栏组件的具体实现如下:

大家可以根据实际需要实现自己的文章打包方式(这里就不奉上我的脚本了)。

4. 更多功能

对于个人博客来说,到这里为止还有很多功能没有实现,这里偷个懒,奉上一些相关的链接吧:

4.1 关于文章评论

在github pagess中加入Disqus评论系统

使用 GitHub Issues 搭建评论系统

4.2 关于文章结构树

TreeMDown

markdown-tree

我最近应该会实现一个React用途的markdown树组件,大家不妨期待下

5. 发布你的个人静态站点5.1 部署到 github pages(基于 gh-pages)

CRA针对github pages用途专门推荐了一个包:gh-pages,使用方法如下:

(1)修改项目的 文件,添加homepage属性:

(2)项目安装 依赖后,在 中添加如下配置:

(3)将本地代码上传到github博客仓库的某个分支(只要不是master分支就行),然后执行:

gh-pages会将CRA项目build到仓库的master分支,然后,你就可以访问你的站点了(有关 CRA 项目部署到 github pages 的详细描述可以看这里)。

5.2 如何兼容 React 的客户端路由(一种比较 hack 的方法)

单页面应用一般需要设置服务端路由,将应用的所有页面路径都重定向到index.html,而github pages并没有这样的默认设置。

因而,当你使用React的客户端路由(React的createBrowserHistory方法创建前端路由)时,除根路径以外的页面,github都会返回自己的404页面。

为此,CRA项目提供了一种比较hack的方法来支持React的客户端路由(通过操作window.history来强行匹配url)。也算是一种奇技淫巧吧。

(1)在CRA项目的public目录下添加一个 ,其内容如下:

(2)在 的head中添加如下代码:

大功告成,你的github站点支持React的客户端路由了。

除此之外,也可以改为使用 方法来创建客户端路由,这样前端路由就与服务端路由没多大关系了,不过url里面一串hash毕竟不够优雅。

有兴趣了解奇技淫巧的童鞋,可以点这里。

5.3 部署到自己的服务

与CRA项目的生产环境部署方式一样:

线上执行 yarn build 命令,站点的所有静态资源将打包到 build 目录下

将你的站点入口配置到 build 目录下

6. 项目参考(源码奉上)

这是我的github博客(基于上述过程实现的静态站点),感兴趣的伙伴可以点击这里查看项目源码,觉得有用也可以fork或star一下下。

  • 发表于:
  • 原文链接:http://kuaibao.qq.com/s/20180131G18QKC00?refer=cp_1026

同媒体快讯

相关快讯

扫码关注云+社区