现在大家都喜欢用markdown来写技术博客,这篇文章将阐述搭建支持markdown的简易博客方法。
我的写作需求
通过阅读本文,您将学会搭建满足以下条件的博客:
- 博客只用书写markdown文件
- 能支持版本控制
- 免费,不需要租服务器或主机
- 编写、部署博客不依赖复杂的环境
技术选型
markdown是一种简单文本格式的书写语法,写好md文件后,要展示在浏览器有三种思路:
-
直接将md文件托管到托管空间,由前端直接解析后展示。如mdwiki
比较下来,我还是选择了最后一种方式,因为它使用起来太简单了,不用搭建任何环境。虽然搭建的博客比较简单,但对于个人博客来说够用了。
mdwiki
mdwiki其实就是用js分析md文件,在前端转换成dom显示在浏览器。使用方法非常简单,直接将mdwiki.html
文件下载下来,重命名为index.html
放在md文件夹根目录即可,浏览器访问的格式为..../index.html#!xx.md
,默认访问index.md。
-
配置
mdwiki可以用json配置一些属性,直接在根目录配置
config.json
文件即可,具体的配置可以参靠官网文档:{ "useSideMenu": true, "title":"非专业Java程序员博客", "lineBreaks": "gfm", "additionalFooterText": "All content and images © by xi.yang | ", "anchorCharacter": "#" }
-
博客目录
mdwiki的目录本身也是用md文件定义的,直接在根目录创建
navigation.md
就行,只能支持2级目录,具体的语法可以参考博客最后的源码分享。 -
主题
mdwiki也支持主题更换,可以去bootswatch下载喜欢的主题css文件,放到根目录,并在
navigation.md
配置对应的主题名称即可:[gimmick:theme](cerulean)
注意名称要小写,如果是默认的bootswatch样式是不用下载css文件的,直接配置名称即可,高阶玩家可以参考语法自己定义漂亮的样式。
自动生成目录
完成以上步骤简单而漂亮的的博客就搭好了,现在要做的就是写md格式博客,并更新目录配置,就可以在博客上看到更新了。但是文章写多了就会感觉很麻烦,每次都要花时间去维护navigation.md
,如果是已经有很多现成的md文档,初始化会更嫌麻烦!
为了简化这个过程,笔者写了个简单的python脚本,根据文件夹和文档直接生成目录配置文件,这样每次无论改动多少内容,直接执行一下python脚本就可以了,具体代码可以直接看源码分享。
码云pages配置
接下来就是发布了,可以发布到github或者码云上,推荐使用码云,毕竟国内速度要快点,随便在码云上创建一个项目,将根目录的所有文件push
上去,然后在服务
-pages
中开启服务即可访问,如:我的博客。
无论用码云还是用github,这时候都是用的他们的二级域名,我们也可以使用自己的域名。首先在根目录创建CNAME
文件,写入自己的域名,如果是github,可以配置自己的域名,然而码云是没有这个功能的,但是可以去域名提供商配置Url转发
(由于笔者在万维网买的域名说开通这个功能还要单独收费,没有测试,理论上是可行的)。
一键部署
完成上面的所有配置后,我们写博客的步骤就简化为:
-
在对应文件夹写md文本博客。
-
执行python脚本。
-
git
命令add、commit、push。
这里git操作很烦,每次我们都要执行好几个命令才能完成部署,细想我们的个人博客其实不需要记录什么提交说明。于是笔者又写了个shell
脚本,将执行python脚本和一系列git命令一起执行。
这样每次改完博客后直接执行这个脚本就完了,非常方便!windows用户装了git直接在git bash界面就可以执行脚本。脚本在源码中也有,执念于提交说明的也可以修改脚本,传入提交说明即可。
源码分享
以上博客集成代码的源码地址为:md_blog,将所有的文件都集成好了,大家fork下来就可以直接用,参考项目的readme几分钟就能完成博客搭建。
网友评论