利用docsify编写专业的接口文档

最新推荐文章于 2023-12-23 22:22:48 发布
最新推荐文章于 2023-12-23 22:22:48 发布
阅读量533 收藏
点赞数
分类专栏： 超好用的工具 Js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/urmljyc/article/details/107906005
版权

由于markdown的易用性，用markdown进行API文档的编辑及展示已经变成了一种趋势，而据我用下来，感觉最好的是docsify，主要是因为他支持的插件更全面，包括搜索，本地化，代码高亮，分栏等等。最关键一点，简捷，因此特别推荐给大家。
点击官方文档说明和我一样开始使用docsify吧！

U.R.M.L
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
爆肝3天！三万字图文并茂手牵手教你docsify文档编写|cvtutorials.com|有源码|不用脑子|有手就行！
机器视觉全栈er的博客
09-14 768
一：网站效果速览 点我速览网站效果 第一次载入较慢，后面会快的飞起。 封面效果： 黑夜模式、侧边栏、代码块点击复制、外部链接 gitalk评论插件： 分页pagination: docsify文档模板放在我的github中了： 机器视觉全栈er的github 手牵手编写docsify文档编写教程链接如下： 三万字手图文并茂手牵手教你docsify文档编写 看教程之前，先看下docsify基本知识介绍 为啥选择docsify编写教程文档？ （以下为个人经验，如有错误，敬请批评指正）】 为啥我不选微信
docsify api文档_Docsify：神奇的文档站点生成器
cuk5340的博客
07-21 381
docsify api文档 Docsify (Docsify) A magical documentation site generator. 一个神奇的文档站点生成器。 Simple and lightweight (~18kB gzipped) No statically built html files Multiple themes 简单轻巧(〜18kB gzip压缩)没有静态生成的...
文档 - - - Docsify文档创建
zichen的博客
12-23 1657
一个神奇的文档网站生成器。docsify 不会生成静态的 .html 文件，所有转换工作都是在运行时。
docsify实现开发文档
九段刀客的博客
07-25 1310
使用场景，在vue的项目中经常会封装公用的组件，单单用markdown写组件文档，因为没有左右分栏功能，查找起来很不方便，用docsify既可以用markdown来编写文档，又可以实现左右分栏导航功能。完美！！！ docsify官方文档地址https://docsify.js.org/#/zh-cn/quickstart 实现效果 配置方法 为了简单方便，没有采用npm。 新建一个文件夹，新...
Docsify使用指南，使用Typora+Docsify打造最强、最轻量级的个人&团队文档，及免费和开源且低成本文档工具
weixin_48290901的博客
11-09 5337
Docsify使用指南，使用Typora+Docsify打造最强、最轻量级的个人&团队文档，及免费和开源且低成本文档工具
使用docsify搭建文档管理平台
05-25
● 无需构建，写完文档直接发布 ● 容易使用并且轻量 (~19kB gzipped) ● 智能的全文搜索 ● 提供多套主题 ● 丰富的 API ● 支持 Emoji ● 兼容 IE10+ ● 支持 SSR
docs-zh:docsify 中文文档
05-10
docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 .html 文件，所有转换工作都是在运行时。如果你想要开始使用它，只需要创建一个 index.html 就可以开始编写文档并直接。 查看...
docsify:docsify文档
03-18
docsify作为一个轻量级的文档生成工具，结合HTML和Markdown的灵活性，为开发者提供了便捷的文档编写和分享方式。无论你是个人项目还是团队协作，docsify都能轻松满足需求，让技术文档的管理和维护变得简单高效。
docsify-blog:docsify文档网站
03-17
Docsify 一个轻巧巧（〜21kB）没有生成静态的html文件主题丰富 ＃安装 本地建造 如果你想在本地建造：npm安装： npm i docsify-cli -g 初始化： docsify init ./docs 本地预览： docsify serve 进入 为了更好地...
docsify:基于docsify的在线私人文档网站
03-28
- **多语言支持**：docsify可以轻松地切换文档语言，方便国际化的文档编写和阅读。 - **SEO优化**：docsify通过元数据支持搜索引擎优化，提高文档的网络可见性。 - **GitHub Pages友好**：docsify非常适合部署到...
【小沐学写作】Docsify制作在线电子书、技术文档（Docsify + Markdown + node）
最新发布
爱看书的小沐
12-23 1484
一个神奇的文档网站生成器。简单轻巧没有静态构建的 html 文件多个主题Docsify会即时生成您的文档网站。与 GitBook 不同，它不会生成静态 html 文件。相反，它会智能地加载和解析您的 Markdown 文件，并将它们显示为网站。要开始使用它，您需要做的就是创建一个并将其部署在 GitHub Pages 上。没有静态构建的 html 文件简单轻巧智能全文搜索插件多个主题有用的插件 APIEmoji 支持与IE11兼容支持服务端渲染。
docsify（三）：新增检索高亮功能
u598975767的专栏
02-08 2222
相关工程部署可参考docsify & docsify-pdf-converter 总结https://blog.csdn.net/u598975767/article/details/122576505 docsify 新增生成词库功能https://blog.csdn.net/u598975767/article/details/122746132 先说一下改动前docsify自带的关键词检索功能： 1. 支持多个关键词同时检索，各关键词以空格、\等符号分开。此功能bug较多，会导致检索..
docsify使用Markdown的====高亮语法
Hubz131的博客
01-23 1404
1、在使用的过程中一直没有找到使用===的扩展包所以只能手动使用JS处理了 2、代码 plugins: [ function(hook, vm) { hook.beforeEach(function (html) { //适配Markdown的====高亮语法 let res = html.match(/==(.+?)==/g); for (var i = 0; i <
GET 新技能！自己的网站突然就不香了
xukangsh的博客
07-05 489
` 松哥自己的网站有两大类： 一个就是大家看到的 www.javaboy.org，这个网站是基于 GitHub Pages 做的，使用的技术栈是 hexo+icarus，公众号上的所有文章我都会同步到这个网站上去。 还有一类就是电子书网站，这个就比较多了： http://maven.javaboy.org http://spring.javaboy.org http://springmvc.javaboy.org http://mybatis.javaboy.org http://springb
Github+docsify打造在线文档网站
tsundere_x的博客
08-23 1685
写在前面 搭建这个在线文档的目的是方便自己对学习笔记的查看，比较喜欢 docsify 的主题风格，所以没有用 Github Pages 直接给的主题，自己根据官方文档进行了配置，目前已经成功上线。 1 效果图 可直接访问：https://xiaojing-c.github.io/Learning-records 2 什么是docsify docsify 是一个动态生成文档网站的工具。可以简单、高效、低成本的搭建一个文档网站。 中文官方文档：https://docsify.js.org/#/zh-cn/
使用Docsify为公司项目添加项目文档
weixin_43254015的博客
06-16 349
在index.html文件中，您可以在对象中配置各种选项来自定义Docsify文档的外观和功能。例如，您可以设置文档的名称、导航栏、侧边栏、搜索功能等。下面是一个示例配置：name : 'My Docsify App' , loadNavbar : true , loadSidebar : true , // 其他配置选项... } </ script >
Docsify保姆级教程
ybb_ymm的专栏
12-29 844
动态生成文档网站的一款热门工具！网上很多关于动态生成文档的工具！今天我们的主角是Docsify！
【docsify基本使用】
小蓝人的博客
06-24 1598
docsify基本使用
docsify制作在线说明文档的轻量级神器
weixin_34396103的博客
02-09 2534
在网上发现了一个使用html ，处理加载md文件，极其简单便可以制作出漂亮的在线说明文档————神器docsify。 GIThub地址:https://github.com/QingWei-Li/docsify/ 中文文档地址（就是一个demo）：https://docsify.js.org/#/zh-cn/ 这个是基于vue2.0的，下面记录一下最简单最快速的用法。 1、复制粘贴以下代码...
docsify多页文档
05-25
docsify 是一款非常方便的文档生成工具，可以快速将 Markdown 格式的文档转换成一个漂亮的静态网站。如果你需要生成多页文档，可以通过以下方式实现： 1. 在 docsify 文档的根目录下创建一个 `_sidebar.md` 文件，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值