欢迎访问原文地址来阅读最新版本
转载请注明出处:http://kang.fun/docsify
除了自己手写一个博客网站,通常快速搭建个人博客有三种方式:
从以上三者的使用经验来看,docsify最大的优点就是“快速”,你的markdown笔记内容无需任何修改,直接被加载到客户端,并由docsify自身的js将这些markdown文件渲染成网页。
最关键的是: 它非常适合与GitHub Pages集成
通过GitHub Pages,无需云服务器和个人域名,在30分钟内就能搭建一个公网上的博客。
这是我通过docsify + Gitee Pages搭建的个人博客:https://kangzhixing.gitee.io/k-blog
下面通过GitHub举例,国内用户可以使用Gitee Pages,二者操作类似。
npm i docsify-cli -g
注意:你需要先安装node
docsify init ./docs
初始化完成后,目录下会出现docs文件夹,里面包含几个文件:
index.html
项目入口README.md
会渲染成项目首页.nojekyll
docsify的文件多为下划线开头,这个文件可以使GitHub Pages 忽略掉这些下划线开头的文件当然,你也可以创建一个index.html
文件,其中引用相关js文件并进行window.$docsify
的配置即可
docsify serve ./docs
运行成功后,可以通过浏览器访问 http://localhost:3000
通过设置index.html
中window.$docsify的 coverpage
参数,可以为你的网站增加封面
<script>
window.$docsify = {
coverpage: true
}
script>
然后在根目录下创建_coverpage.md
文件,具体使用可参考官方文档
通过设置index.html
中的window.$docsify可以开启多页面侧边栏,你可以理解为“左侧菜单”
<script>
window.$docsify = {
loadSidebar: true
}
script>
docsify会寻找_sidebar.md
文件,来渲染多个页面侧边栏,它还支持设定标题的展示级别,具体使用可参考官方文档
这里有一个小工具可以通过文件夹目录结构帮你自动生成_sidebar.md
文件
使用方式:
将docsify-sidebar-generator.jar放到你的docsify根目录下
然后输入以下命令: java -jar docsify-sidebar-generator.jar
官方提供了五种主题,切换index.html
中的css文件即可改变网站的主题风格
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/buble.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/dark.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/pure.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/dolphin.css">
在index.html
中引用全文搜索的js文件,并配置window.$docsify
<script>
window.$docsify = {
search: 'auto'
}
script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js">script>
配置完成后,网站左上角会出现一个搜索框,docsify会帮你在localstorage中建立索引
将你的项目推送到GitHub仓库中
在仓库setting中找到GitHub Pages的设置,提供两个选项:
选择master分支,可以直接读取你的仓库根目录
选择docs,可以读取你仓库里的docs文件夹
设置完成后,页面会显示
Your site is published at https://xxx.github.io/xxx
现在,你就有了个人的在线博客了
你可以专注于文档书写,然后刷新_sidebar.md
并推送到GitHub即可
附一个window下将你的本地仓库自动同步GitHub的bat脚本
@echo off
echo 1. 开始拉取
git pull
echo 2. 生成侧边栏
java -jar .\docsify-sidebar.jar
echo 3. 添加文件
git add *
echo 4. 提交
git commit -m 'sync'
echo 5. 推送
git push