先來看一下我在碼雲上創建的demo:

http://lin1270.gitee.io/nicedoc/#/

GIT自己clone一下:

https://gitee.com/lin1270/nicedoc.git

PRE.------------------------------------

1.如果沒有安裝NODEJS,先安裝一下NODEJS。

2.安裝docsify: ---> 方便本地跑起來看效果,不然直接懟GIT上,可能格式不正確的啦。

npm i docsify-cli

3.創建git。 ----> 方便版本管理。有些文檔,有版本管理,更容易應對扯皮。

4.將GIT拉下來,如果你想用我一樣的結構,就複製一下我的文件夾唄。

5.本地預覽:

docsify serve

當然,也可以創建nodejs項目,在 package.json 中加入腳本: "dev": "docsify serve",

這樣就可以愉快地執行:npm run dev啦。

6.一切就緒就可以傳到GIT了。

7.那麼如何愉快地遠程查看呢?

這就需要配置GIT了。

那麼請參照官方文檔:

https://docsify.js.org/#/deploy?id=github-pages

(我使用碼雲,碼雲自動部署貌似要付費才得,所以我是需要手動更新,才生效的)

(所以建議使用github,github只要PUSH成功,再CTRL+R刷新即可看到更新後的效果了)

文檔結構主要分爲幾部分:

1. 搜尋框。

2.左側菜單。side.md

3.右上角的導航欄。nav.md

4.內容區。

入口:

index.html

看一下配置就知道文檔的組織結構了,不必贅述。

下面帖一下錦榮大佬幫寫的菜單點擊折疊展開的牛B插件代碼:

plugins: [
function(hook, vm) {
hook.doneEach(function() {
var sidebarLiEls = document.querySelectorAll('.sidebar-nav li')
sidebarLiEls.forEach(function(el) {
el.style.cursor = 'pointer'
el.addEventListener('click', function(e) {
e.stopPropagation()
clearActiveClass()
el.classList.add('active')
var targetEl = e.target.children[0] || e.target.nextElementSibling
if (!targetEl) return
if (targetEl.nodeName.toLowerCase() !== 'ul') return
if (targetEl.style.display === 'none') {
targetEl.style.display = 'block'
} else {
targetEl.style.display = 'none'
}
}, false)
}) function clearActiveClass() {
sidebarLiEls.forEach(function(el) {
if (el.classList.contains('active')) {
el.classList.remove('active')
}
})
}
})
}
]

使用 docsify 創建自己的 markdown 文檔系統的更多相关文章

  1. Markdown 文档生成工具

    之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协 ...

  2. 入坑 docsify,一款神奇的文档生成利器!

    layout: postcategory: javatitle: 入坑 docsify,一款神奇的文档生成利器!tagline: by 沉默王二tags: - java Guide 哥是我认识的一个非 ...

  3. 如何創建一個自己的 Composer/Packagist 包 (PHP)

    如何創建一個自己的 Composer/Packagist 包 首先讓我們踏着歡快的腳步去Github創建一個新庫,這裏取名 composer-car,又歡快的將它克隆到本地: git clone ht ...

  4. js 加载并解析Markdown文档

    网上有很多网站会通过.md文档来做页面内容(比如,阮一峰老师的es6入门blog: http://es6.ruanyifeng.com/),很好奇,这是怎么做的?(至于.md是什么,或许(https: ...

  5. 使用Python从Markdown文档中自动生成标题导航

    概述 知识与思路 代码实现 概述 Markdown 很适合于技术写作,因为技术写作并不需要花哨的排版和内容, 只要内容生动而严谨,文笔朴实而优美. 为了编写对读者更友好的文章,有必要生成文章的标题导航 ...

  6. 「Ionic」創建新項目

    1.創建新項目 创建一个名为myApp的还有tabs的项目(ionic start <project-name> <optional-template>) 可选模板为sidem ...

  7. Linux(Ubuntu)使用日记------markdown文档转化为word文档

    Linux(Ubuntu)使用日记------markdown文档转化为word文档

  8. 将markdown文档使用gulp转换为HTML【附带两套css样式】

    将markdown文档使用gulp转换为HTML[附带两套css样式] 今天遇到一个需求,即将Markdown文档转为为HTML在网页展示,身为一名程序员,能用代码解决的问题,手动打一遍无疑是可耻的. ...

  9. [Ms SQL] 基本創建、修改與刪除

    ##創建 table student, 內涵 id ,name ,tel三種columne,設定id為primary key create table student ( id int primary ...

随机推荐

  1. jsp+上传组件+文件夹+文件

    上次遇到这样一个问题,客户上传高清视频(1G以上)的时候上传失败. 一开始以为是session过期或者文件大小受系统限制,导致的错误.查看了系统的配置文件没有看到文件大小限制,web.xml中sees ...

  2. 数据分析师面经一(bk)

    2019年第一个数据分析面试: 先说一下心理感受,在BOSS多次看到这个岗位了,但是 呢一直没勇气去投这个岗位.首先毕竟是一个知名企业一万+人的公司,心里多少底气不足(小公司待习惯了吧),而且看岗位要 ...

  3. Linux之vnc启动及异常处理

    1)启动桌面1的服务 [root@testdb ~]# vncserver :1 New 'testdb:1 (root)' desktop is testdb:1 Starting applicat ...

  4. Android_(自动化)自动获取手机电池的剩余电量

    自动获取手机电池的剩余电量 通过使用BroadcastReceiver的特性来获取手机电池的电量,注册BroadcastReceiver时设置的IntentFilter来获取系统发出的Intent.A ...

  5. ACM之路(19)—— 主席树初探

    长春赛的 I 题是主席树,现在稍微的学了一点主席树,也就算入了个门吧= = 简单的来说主席树就是每个节点上面都是一棵线段树,但是这么多线段树会MLE吧?其实我们解决的办法就是有重复的节点给他利用起来, ...

  6. phpcms9 从注入点入手和 从前台getshell

    弄了3天了  这个点 总结一下这三天的坑吧 0X01 注入点入手 /index.php?m=wap&c=index&a=init&siteid=1 获取cookie 传给 us ...

  7. Inter IPP+ VS + opencv 在 Windows下的环境搭建

    首先Inter官网申请和下载:https://software.intel.com/en-us/intel-ipp 需要VS2013或更高版本(先装vs再装IPP,我的版本是VS2015社区版,IPP ...

  8. 设置PyCharm中选择文本的背景颜色和代码中和选中单词相同单词的背景颜色

    1 设置选中单词的背景颜色 首先进入File->Setting->Editor->Color Scheme后复制一个存在的颜色主题作为自定义的颜色主题(默认的颜色主题是无法修改的,也 ...

  9. C++入门经典-例7.6-this指针,同一个类的不同对象数据

    1:对于类的非静态成员,每个对象都有自己的一份拷贝,即每个对象都有自己的数据成员,不过成员函数却是每个对象共享的.那么调用共享的成员函数如何找到自己的数据成员呢?答案是通过类中隐藏的this指针. 2 ...

  10. TCP被动打开 之 第一次握手-接收SYN

    假定客户端执行主动打开,服务器执行被动打开,客户端发送syn包到服务器,服务器接收该包,进行建立连接请求的相关处理,即第一次握手:本文主要分析第一次握手中被动打开端的处理流程,主动打开端的处理请查阅本 ...