docsify , 网站文档动态生成工具,类似gitbook 特性 无需构建,写完文档直接发布 容易使用并且轻量 (~19kB gzipped) 智能的全文搜索 提供多套主题 丰富的 API 支持 Emoji 兼容 IE10+ 支持 SSR 安装 npm i docsify-cli -g 进入项目根目录并初始化 docsify init ./docs 之后docs目录下会生成以下几个文件 index.html 入口文件 README.md 会做为主页内容渲染 .nojekyll 用于阻止 Git…

使用Docsify做文档网站的详细配置教程 作者:xhemj 没错,它叫Docsify. xhemj的文档中心就是用这个写的 开源地址:https://github.com/docsifyjs/docsify/ 官方Demo:https://docsify.js.org/ 目录 官方说明 安装 如何写文章 个性化 插件 结尾 官方说明 Docsify A magical documentation site generator. Simple and lightweight (~21kB gzi…

最近安装了API文档工具swagger,因为Github上已有详细安装教程,且安装过程中没有碰到大的阻碍,所以此文仅对这次安装做一份大致记录 相关网站 Swagger 官方地址: http://swagger.wordnik.com Github安装详解[springmvc集成swagger]: https://github.com/rlogiacco/swagger-springmvc 网上安装教程[可配合Github安装教程使用]: http://www.jianshu.com/p/5cfb…

作者: zyl910 一.工具比较 为了让前端JavaScript程序更具可维护性,更利于团队开发,文档非常重要.此时便需要使用自动化文档工具了. 我对比了各种JavaScript自动化文档工具,发现JSDuck最适合我.它的优点有-- 生成文档的易读性高,界面美观. 文档注释的语法简单,功能丰富,能比较随意的编写文档注释. 对于 构造函数.闭包.极简主义 这3种方法定义的类,均能正确识别.生成文档. 提供了打包好的exe,可直接在Windows下使用,不用安装 ruby 环境.且其文件小,只有…

ShowDoc,APIDoc,可道云API,语雀-适合IT企业的文档工具 一.ShowDoc官方文档及说明 1.1 它可以用来做什么 1.2 它都有些什么功能 1.3 使用在线的ShowDoc 1.4 Docker方式安装 二.APIDoc 详解 api接口文档生成 2.1 安装apidoc 2.2 配置(apidoc.json) 三.可道云API 四.语雀 一.ShowDoc官方文档及说明 ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率. ShowDoc…

Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具.它从dll文件及其xml注释文件能够 生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为 我们提供完美的.NET类库文…

1. 引言 各位在开发的过程中肯定遇到过被接口文档折磨的经历,由于 RESTful 接口的轻量化以及低耦合性,我们在修改接口后文档更新不及时,导致接口的调用方(无论是前端还是后端)经常抱怨接口与文档不一致.程序员的特点是特别不喜欢写文档,但是又同时特别不喜欢别人不写文档.所以 API 文档工具这时就应运而生了,本篇文章我们将会介绍 API 文档工具 Swagger2 . 2. 快速上手 既然 Swagger2 是一个 API 文档工具,我们就在代码中看一下这个文档工具在 Spring Boot…

文档工具 LEARN HTML = 教程 HTML REFERENCE = 字典 HTML + CSS + JAVASCRIPT = DYNAMIC  HTML 推荐浏览器: Chrome浏览器(有丰富有利于开发者分析的工具) 善变的网页 永远不要相信网页的东西:因为你可以更改浏览器的内存从而改变页面显示内容: 根据意义记忆标签名: div = divide p = paragraph ul = unordered list i = italic b = bold hr = horizontal…

前提 下面的简介摘抄自docsify的官网 https://docsify.js.org 中的简介 docsify是一个神奇的文档网站生成器.他可以快速帮你生成文档网站.不同于GitBook.Hexo的地方是它不会生成静态的.html文件,所有转换工作都是在运行时.如果你想要开始使用他,只需要创建一个index.html就可以开始编写文档并直接部署在GitHub Pages(码云Pages.阿某云OSS或者鹅云COS等等).它的主要特性如下: 无需构建,写完文档直接发布(运行时markdown文…

一.登陆注册 地址:https://www.gitbook.com/ 1.gitbook可使用github账号登录,如果已经注册github可以直接使用github账号登录 2.如果是github账号登录,在登录成功后,点击右上角的头像,选择‘account setting’去设置用户Email信息 二.创建文档 1.点击右上角的‘+New’创建新的BOOk, Public表示所有人可看,Private表示指定人可看 2.创建完成后,可以开始写文档,或者点击Settings->Collabora…