Docsify 笔记

随便说点什么

之前有写过一篇相关的,Gitbook 笔记,但我不太喜欢用 Gitbook,这次发现了 Docsify,感觉还不错,准备用它来搭建笔记站了。

这篇文章只记录我要用到的功能,需要教程请前往 Docsify官网 查找。

安装

需要先保证安装了 Node.js,关于这个我在上一篇 Gitbook 的文章里有写到。

执行下面这行命令安装:

npm i docsify-cli -g

新建一个文件夹,然后进入文件夹内,执行:docsify init

随后目录下会多出这三个文件。

.nojekyll
index.html
README.md

这三个文件分别为:

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

引用自简书里的这篇文章

执行 docsify serve 可以在 http://localhost:3000/ 中进行预览。

编辑相关

创建新文档

如果不需要多层目录的话直接在 README.md 文件同目录下创建新的 .md 格式文档即可,打开后使用 MarkDown 格式编写文档。

然后,关于文档链接,举个例子,例如创建了一个文档名为 o1-1.md。

那么预览链接就是 http://域名/#/o1-1

Docsify 官网就有详细介绍,复制过来一下:

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

编辑左栏

主页面下仅显示 README.md 文档中的内容,如果需要在左栏中显示其他文档,就需要对 index.html 文件进行修改。

<scropt> 标签中添加这么一段:

loadSidebar: true,

然后创建一个名为 _sidebar.md 的文档,打开后如下格式编辑:

<!-- _navbar.md -->

* Getting started

  * [Quick start](quickstart.md)
  * [Writing more pages](more-pages.md)
  * [Custom navbar](custom-navbar.md)
  * [Cover page](cover.md)

* Configuration
  * [Configuration](configuration.md)
  * [Themes](themes.md)
  * [Using plugins](plugins.md)
  * [Markdown configuration](markdown.md)
  * [Language highlight](language-highlight.md)

复制自 Docsify 官网

简单来说就是:

* 分类名称
  * [左栏显示的标题](文档路径和名称)

顶部导航栏相关

编辑 index.html 文件,在 <body> 标签下添加 <nav> 标签。

然后使用 html 语法进行编写。

例如添加主页标签:<a href="/">主页</a>

其他

更多内容建议查看 Docsify 官网文档,docsify.js.org

暂时就写这么多了,之后有什么再补充。


Docsify 笔记
https://vi.diipx.com/2020/DocsifyNote
作者
晚空
发布于
2020年05月29日
许可协议