官网

前言

Docsify的优点

准备工作

工具的的安装（docsify-cli）

项目搭建

如何使用？

基础配置文件

基础配置(index.html)

封面配置（_coverpage.md）

Docsify使用指南

导航栏配置文件（_navbar.md）

侧边栏配置（_sidebar.md）

运行项目

官网

Docsify官网地址 docsify.js.org/

前言

动态生成文档网站的一款热门工具！网上很多关于动态生成文档的工具！今天我们的主角是Docsify！

Docsify的优点

无需构建，写完文档直接发布
容易使用并且轻量
智能的全文搜索
丰富的 API
支持表情——Emoji

准备工作

nodejs下载地址
node.js最新最详细安装教程
markdown语法的积累（Docsify是markdown语法支持）

工具的的安装（docsify-cli）

安装命令如下： npm i docsify-cli -g

安装结果图：

到这里我们的准备工作就搞定了！

项目搭建

找到我们想要初始化的文件夹，比如我这里是E:\docsify，cmd中进入响应的目录执行下面的命令 docsify init ./Docsify-Guide

如下图：、

进入到响应的目录，查看我们的结果，如下图，我们可以看到三个文件夹：

index.html 入口文件

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

接下来我们只需要编辑README.md即可实现我们的接口文档网站了！

如何使用？

基础配置文件

文件作用	文件
基础配置项（入口文件）	index.html
封面配置文件	_coverpage.md
侧边栏配置文件	_sidebar.md
导航栏配置文件	_navbar.md
主页内容渲染文件	README.md
浏览器图标	favicon.ico

简单的文档，有这么几个配置就完全足够了，接下来我们详细的看一下各个配置具体内容！

基础配置(index.html)

<!-- index.html --><script>window.$docsify = {coverpage: true}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>

封面配置（_coverpage.md）

这里我们将官网的封面配置拿过来了

Docsify使用指南

<!-- _coverpage.md --># Docsify使用指南
# docsify
> A magical documentation site generator.- Simple and lightweight
- No statically built html files
- Multiple themes[开始使用 Let Go](/README.md)

导航栏配置文件（_navbar.md）

添加导航配置的时候，需要在index.html页面添加一行代码 loadNavbar: true 如下： window.$docsify = { coverpage: true, loadNavbar: true }

接下来看一下导航的代码

   <!-- _navbar.md -->* 链接到我* [百度地址](https://baidu.com/)* 友情链接* [Docsify](https://docsify.js.org/#/)

侧边栏配置（_sidebar.md）

这个也需要在index中添加一行代码 loadSidebar: true

接下来看我们的具体侧边栏配置：

<!-- _sidebar.md -->
- [**API文档**](README.md)* 用户* [用户相关接口](/user/user.md) <!--注意这里是相对路径-->
* 菜单* [菜单相关接口](/menu/menu.md)

运行项目

很简单，我们只需要执行下面的命令，根据结果，我们可以看到访问路径，这样输入路径就可以访问项目界面

docsify serve Docsify-Guide

浏览器输入 http://localhost:3000/

这里我们就搞定了基本的Docsify配置，更多使用细节后续会慢慢更新！欢迎大家指正！！

欢迎大家点击下方卡片，关注《coder练习生》

Docsify保姆级教程相关推荐

判断是不是链接正则_Python 正则表达式保姆级教程，小学生都看得懂！！
~点击蓝字关注,获取更多资源~ 0 前言上一篇文章,2020,还不会正则???,和小伙伴们一起学习了 Python 中的正则表达式,读完之后,总感觉少了点什么东西,无法尽兴?就好像爱你们的心少了 ...
参考文献顺序不对_Endnote插入参考文献的保姆级教程
作者:白鹤(baihe@iphy.ac.cn) 审核:蔡建旺各位同学看过来,最近由于疫情严重,小伙伴们都憋在家里写论文.这倒不是什么难事,最烦人的是参考文献的插入.一篇博士论文下来,参考论文不说30 ...
SpringBoot 配置 generator代码生成+knife4j接口文档（2种模板设置、逻辑删除、字段填充含代码粘贴可用）保姆级教程（注意事项+建表SQL+代码生成类封装+测试类）
保姆级教程,逻辑删除及字段自动填充设置,特别要说明的是本次用的是MySQL数据库,如果使用Oracle数据库是,数据库配置需要改变,数据库表一定要大写,否则无法生成代码. 数据库表 CREATE TA ...
【NLP保姆级教程】手把手带你RNN文本分类(附代码)
写在前面这是NLP保姆级教程的第二篇----基于RNN的文本分类实现(Text RNN) 参考的的论文是来自2016年复旦大学IJCAI上的发表的关于循环神经网络在多任务文本分类上的应用:Recur ...
图片适应窗口_毕业论文排版保姆级教程——图片和公式排版
[小技巧]Origin作图过程中如何让图看起来更生动 2020-05-30 [小技巧]简单设置让你origin导出的图片不在有大白边 2020-05-29 [干货放送]萤火科研资源免费赠送第一期--必 ...
保姆级教程 CSS 知识点梳理大全，超详细！！！
保姆级教程 CSS 知识点梳理大全,超详细!!! ✴️大家好,我是王同学,好久不见,趁着假期王同学把CSS 知识点梳理了一遍 ✴️如果对你有帮助就给我点个赞吧,这样我们就互不相欠了 ✴️星光不负赶路人 ...
Frp内网穿透保姆级教程 windows内网穿透
Frp内网穿透保姆级教程 windows内网穿透准备工作一台具有公网ip的云服务器(我的是ubuntu) frp程序流程将frps放到具有公网ip的服务器上将frpc放到需要内网穿透机器上, ...
从购买服务器到网站搭建成功保姆级教程~超详细
??从购买服务器到网站搭建成功保姆级教程~真的超详细,各位看官细品 ??前言 ??预备知识 ??什么是云服务器? ??什么是域名? ??什么是SSL证书? ??服务器选配 ??阿里云[官网链接](ht ...
win系统的阿里云服务器部署IDEASpringBoot项目保姆级教程
win系统的阿里云服务器部署SpringBoot项目保姆级教程前言配置阿里云服务器配置环境环境配置中的坑还有别的坑的话,私信我我补充......毕竟配置是最基本的,还想咋样... jar包导 ...

Docsify保姆级教程

官网

前言

Docsify的优点

准备工作

工具的的安装（docsify-cli）

项目搭建

如何使用？

基础配置文件

基础配置(index.html)

封面配置（_coverpage.md）

Docsify使用指南

导航栏配置文件（_navbar.md）

侧边栏配置（_sidebar.md）

运行项目

Docsify保姆级教程相关推荐

最新文章

热门文章