docsify(和 gitbook 一样的好东西)

github地址
英文文档
中文文档
有了 docsify我们就可以编写和下图一样的文档了,方便文档的查阅与长期维护。

屏幕快照 2018-03-31 下午3.01.00.png

通过 github 进行项目管理,随时随地都可以对文档查阅于修改更新。

首先我们需要先安装 npm(我有一篇文章介绍了 npm,如果遇到问题可以参考) 才能继续后续的安装

首先安装 docsify-cli(命令行界面):

npm i docsify-cli -g

接下来就开始使用了,这里我以我正在整理的公司一个云平台文档(cloud-doc)为例介绍如何使用。

  • 首先在 Desktop 创建一个文件夹:cloud-doc
  • cd 到当前目录

以上步骤推荐使用命令行操作,操作步骤截图如下:


屏幕快照 2018-03-31 下午3.31.03.png

初始化项目

如果想在项目的 ./docs 目录里写文档,直接通过 init 初始化项目。

docsify init ./docs

解释:./docs 目录开始是没有的,初始化之后才会出现。为什么说“想在./docs 目录里写文档”?

初始化之后如下图:


屏幕快照 2018-03-31 下午3.39.13.png

开始写文档

初始化成功后,可以看到 ./docs 目录下创建的几个文件

  • index.html 入口文件
  • README.md 会做为主页内容渲染
  • .nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件

上面这句话是docsify 文档上描述的,但是我们在 ./docs目录下却只看到两个文件,如下图:

屏幕快照 2018-03-31 下午3.38.42.png

别急,我们用 VSCode 打开 cloud-doc 就会看到另一个文件,如图:


屏幕快照 2018-03-31 下午4.20.10.png

我们以后编辑文档,就使用 VSCode。

本地预览网站

运行一个本地服务器通过 docsify serve 可以方便的预览效果,而且提供 LiveReload 功能,可以让实时的预览。默认访问 http://localhost:3000

docsify serve docs

Loading提示

初始化时会显示 Loading... 内容,你可以自定义提示信息。

这个东西可有可无,顺带讲一下,在修改上图中所示的 index.html 文件。我们将默认的提示内容“Loding...”改为“正在加载,请稍候。。。”,如下图:


屏幕快照 2018-03-31 下午4.35.35.png

多页文档

如果需要创建多个页面,或者需要多级路由的网站,在 docsify 里也能很容易的实现。例如创建一个 guide.md 文件,那么对应的路由就是 /#/guide。

假设你的目录结构如下:

-| docs/
  -| README.md
  -| guide.md
  -| zh-cn/
    -| README.md
    -| guide.md

那么对应的访问页面将是:

docs/README.md        => http://domain.com
docs/guide.md         => http://domain.com/guide
docs/zh-cn/README.md  => http://domain.com/zh-cn/
docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide

这个就比较重要了,要看明白,她决定着我们能否正确的定制侧边栏。

定制侧边栏

默认情况下,侧边栏会根据当前文档的标题生成目录。也可以设置文档链接,通过 Markdown 文件生成,效果如当前的文档的侧边栏。

首先配置 loadSidebar 选项,这一步也是修改index.html文件的配置:

                                                            index.html
<script>
  window.$docsify = {
    loadSidebar: true
  }
</script>
<script src="//unpkg.com/docsify"></script>

接着创建 _sidebar.md文件,这个文件是需要我们自己手动创建的,如下图:

屏幕快照 2018-03-31 下午4.49.31.png

这个文件是干嘛用的呢?他可厉害了,我们想让侧边栏显示什么就在这个文件里写什么:


屏幕快照 2018-03-31 下午4.55.14.png
屏幕快照 2018-03-31 下午4.54.50.png

每一节显示什么内容,当然就需要另外创建每一个目录对应的文件,然后在这个文件里写内容了,注意每一个文件都必须以.md结尾。对于同一章节的内容我们又可以把他们放到一个文件夹里。

屏幕快照 2018-03-31 下午4.58.28.png

编辑好的内容要记得提交:
git add .
git commit -m "创建文档目录"
git push

FAQ :

1、当使用如下命令本地运行服务器的时候:
docsify serve

会报如下错误:

Run npm config delete prefix or nvm use --delete-prefix v8.9.4 --silent to unset it.

解决办法1,使用以下命令,但是每次都需要使用:

nvm use v8.9.4

解决办法2,使用以下办法,一劳永逸,解决问题根本:

sudo rm -rf /usr/local/{lib/node{,/.npm,_modules},bin,share/man}/{npm*,node*,man1/node*}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,384评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,845评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,148评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,640评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,731评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,712评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,703评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,473评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,915评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,227评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,384评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,063评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,706评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,302评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,531评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,321评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,248评论 2 352

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,028评论 25 707
  • 用到的组件 1、通过CocoaPods安装 2、第三方类库安装 3、第三方服务 友盟社会化分享组件 友盟用户反馈 ...
    SunnyLeong阅读 14,610评论 1 180
  • 文档: 文档中的键是有序的。{'a': 'b', 'c': 'd'} 和 {'c': 'd', 'a': 'b'...
    kker阅读 144评论 0 0
  • 第一次用这个软件,打算用一年半到高中毕业。尽量每天记录我努力学习又有所偷懒的两年生活吧,奋斗过便不枉少年。 晚安。
    74Cheese阅读 102评论 0 0
  • 我的正面管教日记 两个孩子是时常会打架的,为一些莫名其妙的小事儿。 比如,我家楼下有一只邻居养的小仓鼠,就放在一楼...
    江來阅读 435评论 1 2