文档生成工具docsify

1.快速上手

全局安装docsify-cli

npm i docsify-cli -g

初始化项目

docsify init ./docs

会在docs文件夹里生成三个文件

index.html 作为入口文件
README.md 作为主页
.nojekyll 防止 GitHub Pages 忽略以下划线开头的文件

修改./docs/README.md文件就可以轻松地更新文档中的内容

运行

docsify serve docs

可以在浏览器中预览您的网站http://localhost:3000

2.常见配置项

（1）开启封面功能

通过在index.html里设置coverpage为true来激活封面功能，并创建一个_coverpage.md文件

<!-- index.html --><script>window.$docsify = {coverpage: true}
</script>

<!-- _coverpage.md -->![logo](https://docsify.js.org/_media/icon.svg)# 文档生成工具docsify学习 <small>Bertil Chan</small>> 不甘平凡，不敢平凡- Simple and lightweight
- No statically built html files
- Multiple themes[GitHub](https://github.com/bertilchan)
[Get Started](#文档生成工具docsify)

（2）修改主题

在index.html中修改引入的css样式即可，有下面七种可选。

<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css" />
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/buble.css" />
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/dark.css" />
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/pure.css" />
<!-- Theme: Defaults -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-defaults.css">
<!-- Theme: Simple -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
<!-- Theme: Simple Dark -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">

我这里选了buble主题，效果如下

（3）自定义导航栏

通过在index.html里设置loadNavbar为true并创建_navbar.md

您需要创建一个.nojekyllin./docs以防止 GitHub Pages 忽略以下划线开头的文件。

<!-- index.html --><script>window.$docsify = {coverpage: true,loadNavbar: true}
</script>

<!-- _navbar.md -->* 快速上手* [Quick start](quickstart.md)* [Writing more pages](more-pages.md)* [Custom navbar](custom-navbar.md)* [Cover page](cover.md)* 常用配置* [Configuration](configuration.md)* [Themes](themes.md)* [Using plugins](plugins.md)* [Markdown configuration](markdown.md)* [Language highlight](language-highlight.md)

官方文档：https://docsify.js.org/#/quickstart

文档生成工具docsify光速上手相关推荐

springboot的api_【粉丝投稿】无需额外注解的 SpringBoot API文档生成工具
点击上方"蓝字"关注我们吧! JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具. 编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又 ...
android api文档_【粉丝投稿】无需额外注解的 SpringBoot API文档生成工具
点击上方"蓝字"关注我们吧! JApiDocs是一个无需额外注解.开箱即用的SpringBoot接口文档生成工具. 编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又 ...
mysql 文档生成器_最好用的数据库文档生成工具
一前言本文介绍一些比较流行的数据库文档生成工具,什么是数据库文档? 其实在工作中进行项目交付的时候经常用到:简单来说数据库文档就是对整个数据库设计说明的文档,比如使用了哪个数据库,每张表的字段,类 ...
猿创征文｜小而巧的API文档生成工具之smart-doc
文章目录 smart-doc介绍 smart-doc特性 smart-doc的最佳搭档谁在使用smart-doc smart-doc的优缺点 smart-doc和swagger区别比较 smart- ...
超好用的数据库设计文档生成工具
原创声明:本文为作者(幻好)原创,可用做学习参考转载,但需注明出处.禁止未经允许用于商业等途径,否则后果自负! 前言概述随着开发场景的复杂度越来越高,存储数据的数据库表也越来越多并不断的更新.在开发 ...
Apiggs —— 非侵入性的 RestDoc 文档生成工具
程序员一直以来都有一个烦恼,只想写代码,不想写文档.代码就表达了我的思想和灵魂. Python提出了一个方案,叫docstring,来试图解决这个问题.即编写代码,同时也能写出文档,保持代码和文档的一 ...
.NET平台开源项目速览(4).NET文档生成工具ADB及使用
.NET平台开源项目速览(4).NET文档生成工具ADB及使用原文:.NET平台开源项目速览(4).NET文档生成工具ADB及使用很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习 ...
Doxygen自动文档生成工具在Eclipse中的集成及使用举例
你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的 ...
unity mysql生成cexcel_【C#附源码】数据库文档生成工具支持（Excel+Html）
[2015] 很多时候,我们在生成数据库文档时,使用某些工具,可效果总不理想,不是内容不详细,就是表现效果一般般.很多还是word.html的.看着真是别扭.本人习惯用Excel,所以闲暇时,就简单的 ...

文档生成工具docsify光速上手