快捷搜索:  汽车  科技

docsify使用方法(Docsify-3分钟搭建属于自己的技术文档WIKI)

docsify使用方法(Docsify-3分钟搭建属于自己的技术文档WIKI)npm i docsify-cli -g docsify init ./docs 生成目录如下:下载地址:https://nodejs.org/dist/v8.9.4/node-v8.9.4-x64.msi 下载完成后点击安装。 查看node 版本,命令:node -v 版本:v8.9.4docsify安装这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件“污染” commit 记录,只需要创建一个 index.htmlDocsify安装及使用node安装

docsify使用方法(Docsify-3分钟搭建属于自己的技术文档WIKI)(1)

Docsify是什么

docsify 是一个动态生成文档网站的工具,可以将.md 文件以 wiki 的形式展示给读者,可以用于制作技术文档、用户手册、wiki 等。可以部署于主机、VPS、GitHub、静态云存储(例如阿里云 OSS)。

官网:https://docsify.js.org/#/

docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。

这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件“污染” commit 记录,只需要创建一个 index.html

特性
  • 无需构建,写完文档直接发布
  • 容易使用并且轻量 (压缩后 ~21kB)
  • 智能的全文搜索
  • 提供多套主题
  • 丰富的 API
  • 支持 Emoji
  • 兼容 IE11
  • 支持服务端渲染 SSR (示例)

Docsify安装及使用

node安装

下载地址:https://nodejs.org/dist/v8.9.4/node-v8.9.4-x64.msi 下载完成后点击安装。 查看node 版本,命令:node -v 版本:v8.9.4

docsify安装

npm i docsify-cli -g docsify init ./docs

生成目录如下:

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

docsify 启动

本地启动

docsify serve docs

Docsify高级特性

docsify的配置

window.$docsify = { name: '研发中心' repo: 'https://git.git' loadNavbar: true loadSidebar: true // 加载自定义侧边栏 maxLevel: 2 // 默认情况下会抓取文档中所有标题渲染成目录,可配置最大支持渲染的标题层级。 subMaxLevel: 4 // 生成目录的最大层级 mergeNavbar: true // 小屏设备下合并导航栏到侧边栏 alias: { // 定义路由别名,可以更自由的定义路由规则。 支持正则 '/.*/_sidebar.md': '/_sidebar.md' //防止意外回退 '/.*/_navbar.md': '/_navbar.md' } }

动态生成目录

获取代码

执行自动生成命令

会增加_siderbar.md

docsify使用方法(Docsify-3分钟搭建属于自己的技术文档WIKI)(2)

执行后

docsify使用方法(Docsify-3分钟搭建属于自己的技术文档WIKI)(3)

运行效果

docsify使用方法(Docsify-3分钟搭建属于自己的技术文档WIKI)(4)

获取代码

欢迎关注 回复“docsify”,获取免费获取源码下载地址;

猜您喜欢: