Sphinx https://www.sphinx.org.cn/ Sphinx是一个工具,可以轻松创建由Georg Brandl编写并根据BSD许可证授权的智能和美观文档 它最初是为Python文档创建的,它具有出色的工具,可用于各种语言的软件项目文档. 当然,这个站点也是使用reStructuredText源创建的 输出格式: HTML(包括Windows HTML帮助),LaTeX(适用于可打印的PDF版本),ePub,Texinfo,手册页,纯文本 广泛的交叉引用: 语义标记和功能,类,…

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

最近安装了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 环境.且其文件小,只有…

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…

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…

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

初次接触Swagger是在2017年5月,当时公司正好要对整套系统架构进行重新设计,有同事推荐用这个技术框架来规范后台接口的API文档.当时因为架构重构,涉及改造的技术点太多,一时也就没太多精力,把Swagger暂时放下了.对于API文档我们就自己定义了一个模板,统一要求开发人员把文档写在tower上了. 现在回头来看,存在这么几个问题: 1. 文档编写及修改的及时性不够,由于API在开发及测试过程中经常会有调整,相应的文档不能及时得到修改. 2. 文档的规范性需要人为的检查来约束,增大了项目管…

作者: zyl910 一.缘由 "Sandcastle Help File Builder"(简称SHFB)是一个很好用.NET 帮助文档生成工具. 但它的每个版本支持的VS版本范围有限,且官网没有明确说明它与VS版本的区别.导致经常出现"明明装了SHFB,但VS打开不了它的项目"问题. 这时只有逐个版本安装尝试了.而GitHub下载速度慢,导致要花很久时间才能找到合适的版本.于是我做了一次完整的实验,有了一些心得. 二.心得 2.1 尝试安装2个版本 最初曾经试过…

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

参考资料: http://my.oschina.net/wangxuanyihaha/blog/188909   LDoc介绍:     LDoc是一个Lua的文档生成工具,过去,比较常用的Lua生成文档的工具是LuaDoc,可惜作者自从2008年之后就再也没有发布过新的版本了,说明作者基本上已经放弃维护了.而LDoc则是一直在更新中,所以现在选择LDoc来给Lua生成文档是更好的选择,LDoc的Github主页. LDoc的一个优点就是,它的目的是为了和LuaDoc兼容并且拓展LuaDoc的功…

一.概述 原文地址:https://pro.ant.design/docs/api-doc-cn 在日常开发中,往往是前后端分离的,这个时候约定好一套接口标准,前后端各自独立开发,就不会被对方的技术难点给阻塞住,从而保证项目进度. 在 Ant Design Pro 中我们已经有了一套比较完善的 mock 功能,而 roadhog-api-doc 工具,则能够从项目的 mock 数据中读取接口信息生成对应的文档,这样就能够更加清晰明了的展现项目的接口情况. 效果如下:Pro API Docs. 二…

平台选型         Apidoc         文档参考:http://apidocjs.com        优点      文档齐全,操作简单,ui清晰,代码注解查询性强,语言支持多元化,写接口方便        缺点      需要配合发布方案   备选方案        doxmate  和apidoc类似,生成的页面也很精美,同样支持注释风格内容解析.缺点是依赖较多,操作较为复杂.      https://github.com/tj/dox      http://html5…

一个非侵入的api编译.收集.Rest文档生成工具.工具通过分析代码和注释,获取文档信息,生成RestDoc文档 前言 程序员一直以来都有一个烦恼,只想写代码,不想写文档.代码就表达了我的思想和灵魂. Python提出了一个方案,叫docstring,来试图解决这个问题.即编写代码,同时也能写出文档,保持代码和文档的一致.docstring说白了就是一堆代码中的注释.Python的docstring可以通过help函数直接输出一份有格式的文档,本工具的思想与此类似. 代码即文档 Apigcc是一…

工具开源地址 swagger2 : https://swagger.io/ smart-doc: https://www.oschina.net/p/smart-doc  国产 两者的比较 swagger2 和 smart-doc 两个开源工具 都可以 使用jar包 生成 api 文档. 相同点: 这个两个工具 都可以 自动 扫描 有 @Controller 注解的 类 并生成  相应的 api 接口文档.都可以生成 静态网页,提供在线api html 页面的访问. 区别: 1.swagger2…

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

pdfFactory的快照功能,是通过一种类似截图的方式,将文档中的内容,如标题.图片.段落.文字等进行剪切的功能.剪切后的内容会转化为文本框的形式,我们可以对其进行加边框.旋转等编辑处理,但不能对其进行文本格式的调整. 接下来,就给大家重点讲讲快照的分离与裁剪功能. 图1:快照功能 一.打开缩略图视图 为了更好地演示快照工具的分离与裁剪效果,这里以一个两页文档为例,同时将文档调整为缩略图视图,以便更好地观察文档内容的变化. 图2:缩略图视图 二.使用快照工具 然后,就可以单击pdfFactor…

虽然有go语言的swagger,但是go版本的swagger对代码的侵入比较大,因此抽空实现了基于GO语言生成markdown文档的工具 开源链接地址: https://github.com/w3liu/gendoc gendoc 文档生成工具 MarkDown生成说明 示例 // doc是字段说明 // 如果是必填項,doc里填写 required 即可,注意required前面需要加空格 type ReqCreateOrder struct { Pass string `json:"pass…

提起帮助文档,想必大家都会想到 VuePress等,我也体验了一下,但是感觉和我的思路不太一样,我希望的是那种可以直接在线编辑文档,然后无需编译就可以直接发布的方式,另外可以在线写(修改)代码并且运行的效果. VuePress 是"静态网站生成器",需要我们自行编写文档,然后交给VuePress变成网站,VuePress 并没有提供编写环境,我知道有很多编写 Markdown 的方式,但是我还是喜欢编写.浏览合为"一体"的方式. 似乎没有,那么 -- 自己动手丰衣足…

前言 之前想用Markdown来写框架文档,找来找去发现还是Jekyll的多,但又感觉不是很合我的需求 于是打算自己简单弄一个展示Markdown文档的网站工具,要支持多版本.多语言.导航.页内导航等,并且支持Github Pages免费站点 组件选择 我自己呢比较喜欢C#,恰好现在ASP.Net Core Blazor支持WebAssembly,绝大部分代码都可以用C#完成 对于Markdown的分析,可以使用markdig组件(有个缺点,目前它把生成Html的代码也放到了程序集里,增加了不少…

在逸橙呆了不到两年,开发时后端都有开发接口API,来到数库,好多后端开发和前端沟通是还是发doc文档,很不方便,我向cto反应,自己找到这个,老乡田雷(php,隔壁村的)也用过,可能某些原因选择其他的,若一个公司没有行程约束力,开发文档还是不会达到满意的. 我个人觉得有总比没有强,其中我做的一个h5插件使用发放,就是写在这个文档上面,可以随时阅览查看, http://www.showdoc.cc/sdk?page_id=32735 访问密码 :123456…

package com.sicdt.library.core.utils; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.util.Map; import java.util.Set; import org.apache.poi.hwpf.HWPFDocument; import org.apache.poi.hwpf.usermo…

一.安装swagger 新建一个net core的api项目,通过NuGet安装Swashbuckle.AspNetCore. 二.注册swagger服务 在Startup.cs中注册Swagger生成器. public void ConfigureServices(IServiceCollection services) { services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2); //注册Swag…

laravel-doc ⛵laravel-doc 是一个用来生成文档,通过markdown来撰写文档,并提供web访问文档的项目 安装要求 PHP >= 7.0.0 Laravel >= 5 安装 composer require foryoufeng/laravel-doc     如果你是运行的Laravel 5.5以下的版本,需要在config/app.php的service provider中添加: Foryoufeng\Doc\DocServiceProvider::class  …

此为广告商内容使用最新版的dede cms建站 V5.7 sp1,经常注意后台的升级信息哦!一.安装DEDE的时候数据库的表前缀,最好改一下,不用dedecms默认的前缀dede_,随便一个名称即可.二.安装DEDE程序后,一定修改dede这个文件夹名称,也就是修改你的后台路径!三.后台管理员不要使用admin或者其他一类很容易被猜到的账号,后台登录开启验证码功能!四.安装好程序后务必删除install目录五.用不到的功能一概关闭,比如会员.评论等,如果没有必要通通在后台关闭.六.删除一些用不到…

ShowDoc:https://www.showdoc.cc/ --待更.…

文档生成工具: 自带的pydoc,比较差 建议使用sphinx 安装: pip install sphinx 安装主题: 由各种主题,我选择常用的sphinx_rtd_theme pip install sphinx_rtd_theme 使用方法: 1.创建文件夹doc:mkdir doc:cd doc:执行sphinx-quickstart,进入引导,根据需要选择yes或者no 2.执行sphinx-quickstart引导程序只会生成一个index.rst 3.在doc目录下执行sphinx…

sphinx简介sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对C/C++项目也有很好的支持.更多详细特性请参考spinx官方文档,本篇博客主要介绍如何快速为你的Python注释生成API文档. 环境需要安装python安装sphinxpip install sphinx1实例新建一个项目 目录结构如上图所示,…

sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发. 新版的Python3文档就是由sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对C/C++项目也有很好的支持. 更多详细特性请参考spinx官方文档 sphinx安装 需要安装python pip install sphinx 示例 新建一个项目 目录结构如下, doc目录使用来存放API文档, src目录是用来存放项目的…