Docsify保姆级教程

news2024/11/6 3:10:16

官网

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练习生》

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/128260.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

很好用的Unity编辑器扩展工具 Odin Inspector教程

Odin Inspector是什么&#xff1f; Odin Inspector是Unity的一个插件&#xff0c;让您可以享受拥有强大&#xff0c;自定义和用户友好编辑器的所有工作流程优势&#xff0c;而无需编写任何自定义编辑器代码。 Odin包含许多功能&#xff0c;例如Static Inspector&#xff0c;Pr…

Mybatis框架(一)初识Mybatis之Mybatis简单使用

本文是本人专栏【Java开发后端系列框架】里的文章&#xff0c;文章根据各框架官网与网上资料加上本人工作经验&#xff0c;进行修改总结发布在这个专栏&#xff0c;主要目的是用于自我提升&#xff0c;不用于获取利益。如果系列文章能到帮到您本人将感到荣幸&#xff0c;如果有…

修改配置文件解决matplotlib中文与正负号乱码问题

步骤如下&#xff1a; 1、 找到配置文件matplotlibrc 不管是啥系统&#xff0c;都可以通过以下方式查找matplotlibrc所在的文件夹&#xff08;可以在终端或者编译器中运行以下代码&#xff09; import matplotlib# 查找字体路径 print(matplotlib.matplotlib_fname())结果&am…

策略模式Strategy

1.意图&#xff1a;定义一系列的算法&#xff0c;把它们一个个封装起来&#xff0c;并且使它们可以相互替换。此模式使得算法可以独立于使用它们的客户而变化。 2.结构 Strategy&#xff08;策略&#xff09;定义所有支持的算法的公共接口。Context使用这个接口来调用某Concre…

小梅哥FPGA时序分析和约束实例演练课程

P1 FPGA基本原理 基本结构 三要素可类比电路板的器件、连线、对外端子 可编程逻辑功能块 触发器用于实现时序逻辑&#xff0c;进位链用于可编程逻辑块间通讯&#xff0c;使用较少。 具体器件的可编程逻辑功能块结构。第5代将四输入查找表升级到六输入查找表 由上面两个图抽象…

Flink系列-3、Flink入门案例

版权声明&#xff1a;本文为博主原创文章&#xff0c;遵循 CC 4.0 BY-SA 版权协议&#xff0c;转载请附上原文出处链接和本声明。 大数据系列文章目录 官方网址&#xff1a;https://flink.apache.org/ 学习资料&#xff1a;https://flink-learning.org.cn/ 目录Flink程序模型…

Linux内核中sk_buff结构详解

目录 1.sk_buff结构体 1.1 sk_buff在内核中的结构 1.2 重要的长度len的解析 2. sk_buff数据区 2.1 线性数据区 2.2 非线性数据区 ---------------------------------------------------------------------------------------------------------------------------- 1.s…

内置常量--R

1. R中内置的常量 R中内置的常量有&#xff1a;1. LETTERS&#xff1a; 26个大写英文字母2. letters: 26个小写英文字母3. month.abb: 月份英文前三个字母组成的缩写4. month.name: 月份的英文名字5. pi : 圆周率π

TensorRT介绍及使用

1、简介 TensorRT是一个针对已训练好模型的SDK&#xff0c;通过该SDK能够在NVIDIA的设备上进行高性能的推理。优点如下&#xff1a; 总结下来主要有以下6点&#xff1a; Reduced Precision&#xff1a;将模型量化成INT8或者FP16的数据类型&#xff08;在保证精度不变或略微降…

Linux学习笔记——Linux实用操作(三)

4.10、环境变量 学习目标&#xff1a; 理解环境变量的作用掌握符号$的作用掌握在Linux中配置环境变量 4.10.1、环境变量 1、在讲解which命令的时候&#xff0c;我们知道使用的一系列命令其实本质上就是一个个的可执行程序。 比如&#xff0c;cd命令的本体就是&#xff1a;…

股价狂跌超70%,特斯拉到底怎么了?

​在2022年的尾声&#xff0c;曾在新能源汽车领域盛极一时的特斯拉即将取得上市以来最糟糕的年度表现&#xff0c;直接跌出全球上公司市值前10名。目前特斯拉已连续第7个交易日下跌&#xff0c;截至2022年12月28日&#xff0c;跌超11%&#xff0c;创八个月最大跌幅&#xff0c;…

Leetcode 855. 考场就座

在考场里&#xff0c;一排有 N 个座位&#xff0c;分别编号为 0, 1, 2, ..., N-1 。当学生进入考场后&#xff0c;他必须坐在能够使他与离他最近的人之间的距离达到最大化的座位上。如果有多个这样的座位&#xff0c;他会坐在编号最小的座位上。(另外&#xff0c;如果考场里没有…

「回顾2022,展望2023」- 技术和兴趣,工作和生活,我们都在旅途中

技术 Java&#xff0c;云原生&#xff0c;前端 技术面好像变窄了 远离CI/CD&#xff0c;重新回到起点 2019年毕业&#xff0c;2018年9月份在距离学校(南昌)不远不近的公司实习开始实习&#xff0c;毕业后去过深圳、上海&#xff0c;最后是杭州&#xff0c;到现在&#xff0c;又…

OV7670图像传感器介绍

OV7670图像传感器简介 OV7670是图像传感器&#xff0c;其体积小、工作电压低&#xff0c;能提供单片VGA摄像头和影像处理器的所有功能。通过SCCB 总线控制&#xff0c;可以输出整帧、子采样、取窗口等方式的各种分辨率8位影响数据。该产品VGA图像最高达到30帧/秒。用户可以完全…

西门子PLC串口协议与以太网通信协议对比

西门子plc品牌众多&#xff0c;通信协议的类型就更多了&#xff0c;具体可分为串口协议和以太网通信协议两大类。 串口协议主要有&#xff1a;MODBUS RTU 通信协议&#xff1b;PROFIBUS 通信协议&#xff1b;USS通信协议&#xff1b;PPI通信协议&#xff1b;MPI通信协议&#…

YGG:2022年年终回顾

2022 年&#xff0c;Yield Guild Games&#xff08;YGG&#xff09;扩大并发展了区块链游戏生态系统和开放的元宇宙。在这篇文章中&#xff0c;我们庆祝我们的公会成员、合作伙伴和社区所取得的里程碑式的成就&#xff0c;并期待接下来的发展。 游戏和基础设施合作伙伴的数量不…

推荐 6 个 GitHub 开源项目

本期推荐开源项目目录&#xff1a;1. B 站自动任务工具2. 学习 Solidity3. 高性能异步抖音爬取工具4. Java学习指南5. 中后台管理系统模版6. ChatGPT 中文调教指南01B 站自动任务工具BiliBiliTool 是一个自动化工具&#xff0c;它可以帮助你每天获取经验、每日签到、批量取关等…

分享几个嵌入式 C 中的实用技巧

1、动态绑定、回调函数 回调函数可以达到动态绑定的作用&#xff0c;在一定程度上可以降低层与层之间的耦合。关于回调函数&#xff0c;之前已经有写过一篇&#xff1a;C语言、嵌入式重点知识&#xff1a;回调函数。可能很多初学的小伙伴可能还不理解回调函数&#xff0c;可以…

【计算机图形学入门】笔记9:Shading3着色(插值、高级纹理映射)

09Shading3着色&#xff08;插值、高级纹理映射&#xff09;1.Barycentric Coordinates 重心坐标1.A点自己的重心坐标2.如何求出任意点的重心坐标&#xff1f;2.如何把纹理应用在实际的渲染中&#xff1f;Applying Textures3.Texture Magnification纹理放大。&#xff08;解决纹…

Transform+ASM插桩系列(1)——熟悉Java字节码

前言 为什么要学习Java字节码呢&#xff0c;因为我们学的是插桩字节码技术&#xff0c;这块技术的根底就是字节码&#xff0c;要学会字节码的阅读和字节码的编写&#xff0c;虽然现在很多工具可以帮我们阅读和编写&#xff0c;但最根本的知识还是要理解的。万层楼高从地起&…