上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown基本语法也没啥好说的,随便百度一下几分钟看懂基本的,20%的知识完成80%的任务嘛,够了. 关键在于,我有些特殊需求,以方便将Markdown作为接口文档查看.什么需求呢? 目录.这是重中之重.没有方便的TOC的话,文档长了,查看起来真是费劲.我理想中的目录是这样的: 根据H1(# ).H2(## …

最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而且成熟的方案了,话不多说,我也搞一搞试试. 电脑操作系统:deepin深度 Linux64位,比较难用的一个系统,但是公司强制使用,没办法 1.这里我用到了gitbook,GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出…

我想要在 Github 上开一个主题博客,我希望通过 Markdown 语法写作,然后生成 HTML 并附带自定义样式显示在网页上. 我找到了 gulp-markdown 这个库,看起来符合我的需求场景.然而这个库有一个问题,他只能将 Markdown 语法书写的文字转换为 HTML 标签,但并不能自动添加 doctype 文档声明,这就意味着生成的 HTML 文档并不合法. # 标题 我是正文. 会被编译为 <h1>标题</h1> <p>我是正文</p>…

Spec Markdown 是一个基于markdown 的文档编写工具,安装简单,可以让我们编写出专业的文档 参考项目 https://github.com/rongfengliang/spec-md-demo 安装 全局 npm install -g spec-md 本地项目依赖 npm install --save-dev spec-md 项目使用 因为个人原因,比较喜欢使用yarn,所以项目基于yarn 初始化 初始化 yarn init -y 配置构建&&依赖 yarn add s…

背景介绍 作为一个技术人员,基本都需要编写技术相关文档,而且大部分技术人员都应该掌握 markdown 这个技能,使用 markdown 来编写并生成 PDF 文档将会是一个不错的体验,以下就介绍下如何使用 VS Code + Markdown 来编写 PDF 文档 效果演示 环境准备 [必须]安装 Visual Studio Code [必须]安装 Extension - Markdown PDF,主要用于生成 PDF [可选]安装 Extension - markdownlint,用于 ma…

当今大多数的团队都实现了前.后端分支.前端与后端的沟通都是通过接口来实现的(一般情况下都是webapi接口).这种情况你肯定需要一个接口查询的帮助文档,这个当然用swagger都可以实现.但做为前端开发的我们是否也应该考虑把自己写的组件以帮助文档的方式公开都团队其他人员使用.就像iview,easyui等UI组件都有自己的帮助文档.今天我们都介绍一套工具(其中某些组件经过本人的改造) 一.需要的组件 1. Hexo:静态博客生成器 2. Hexo-theme-doc:基于Hexo实现的帮助文档类…

源文件 https://files.cnblogs.com/files/bincoding/%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3.zip 目录 测试接口 查询指定项目属性** 接口功能 获取制定项目的分类信息 接口地址 https://www.bincoding.cn/test HTTP请求方式 POST JSON 请求参数 参数 必选 类型 说明 name ture string 请求内容1 type true int 请求内容2 返回字段 返回字段 字段类…

接口名称 1) 请求地址 https://apis.cnblogs.com/user/info?a=xx&b=xx 2) 调用方式:HTTP GET 3) 接口描述: 接口描述详情 4) 请求参数: GET参数: 字段名称 字段说明 类型 必填 备注 a string Y - b string Y - 5) 请求返回结果: { "errNum": 10001, "errMsg": "Param error" } 6) 请求返回结果参数说明…

作者:吴香伟 发表于 2014/08/07 版权声明:可以任意转载,转载时务必以超链接形式标明文章原始出处和作者信息以及版权声明 本文不讲解Markdown的语法规则,只关注它带来的好处以及我使用的方法.语法规则可以参考Markdown: Syntax. 文档内容和格式分离 使用Word写文档总花费很多时间在调整格式,并且往往最终也没让自已满意.这对有洁癖的人来说痛苦非常.Markdown只通过几个简单的符号表示文档的格式,比如##代表二级标题,**X**代表强调内容X,*X*代表X的字体为斜体…

最近使用 DocFX 对 Rafy 框架的帮助文档进行了升级. SandCastle 之前 Rafy 框架的帮助文档,是使用 SandCastle 来编写的(https://github.com/EWSoftware/SHFB).如下图: 其文档中的每一个文档都是一个 .aml 文件.aml 文件是一种自定义格式的 xml 文件.示例如下: <?xml version="1.0" encoding="utf-8"?> <topic id="…

将markdown文档使用gulp转换为HTML[附带两套css样式] 今天遇到一个需求,即将Markdown文档转为为HTML在网页展示,身为一名程序员,能用代码解决的问题,手动打一遍无疑是可耻的.上代码 首先是安装依赖 cnpm i gulp -g //针对没有全局安装gulp的用户 cnpm i gulp gulp-markdown gulp-header --save-dev //安装本地依赖 创建gulpfile.js /* * @Author: Carl Elias * @Date:…

Markdown 介绍 Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档. Markdown 语言在 2004 由约翰·格鲁伯(英语:John Gruber)创建. Markdown 编写的文档可以导出 HTML .Word.图像.PDF.Epub 等多种格式的文档. Markdown 编写的文档后缀为 .md, .markdown. Markdown 标题 Markdown标题有两种格式. 1.使用 = 和 - 标记一级和二级标题 = 和- 标记语法格式如下:…

前言 最近做的项目使用了微前端框架single-spa. 对于这类微前端框架而言,通常有个utility应用,也就是公共应用,里面是各个子应用之间可以共用的一些公共组件或者方法. 对于一个团队而言,项目中公共组件和方法的使用难点不在于封装不在于技术,很多时候在于团队内部成员是否都能了解这些组件,以避免重复开发,从而提升团队效率. 如果是团队比较小,人员比较稳定的项目组可能还好点,对于团队比较大,人员流动较快的团队,这些通用组件和方法往往就被人遗忘在角落,很难再得到有效利用. 因为我所在的项目还在…

V1.0 最终修改于2016/10/19 概述 软件工程中,一份优雅的文档不仅能降低团队成员之间的沟通难度,而且能给之后的开发者提供一个非常有效的引导.本团队为了规范整个项目中文档的格式,便于统一管理与清晰的阅读,特制订以下格式规范. 为了方便博客端和Github端的文档统一编写,统一风格,因此选用Markdown语法作为文档编写的格式.但是由于Markdown为纯文本格式,对图片.颜色.表格等元素的支持非常困难,因此在编写图片表格较多的博客时,允许使用Microsoft Office Word…

Web API文档工具列表Swagger ——Swagger框架可以通过代码生成漂亮的在线API,甚至可以提供运行示例.支持Scala.Java.Javascript.Ruby.PHP甚至 Actionscript 3.在线 Demo .I/O Docs ——I/O Docs是一个用于RESTful Web APIs的交互式文档系统.使用 JSON 模型根据资源.方法和参数定义 APIs.I/O Docs 将生成 JavaScript 客户端接口,可通过这些接口来调用系统.服务器端基于 Node…

使用Mkdocs构建你的项目文档 环境搭建 安装必需软件 作者是在windows下安装的,如果是linux或mac用户,官网有更详细的安装说明. windows 10 x64 当然还有广大的windows 7/8 用户,也是适用的. python 3.4 x86版本(必备依赖) 下载地址:https://www.python.org/downloads/release/python-344rc1/ pip(pytone包管理器) 下载地址:https://pypi.python.org/pypi…

mkdocs是Python的一个对 Markdown 友好的文档生成器.,小巧精美. MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YA…

api文档 php 在项目中,需要协同开发,所以会写许多API文档给其他同事,以前都是写一个简单的TXT文本或Word文档,口口相传,这种方式比较老土了,所以,需要有个api管理系统专门来管理这些api,从网上找了许多比较好的开源文档管理系统,可以应用到项目中. 1.国外的话Swaggerswagger-ui 2.国内的Showdoc国内开源的非常好用的一款API文档管理系统,安装也非常方便,只需将源代码放到项目目录下自动安装运行即可,不要要注意PHP版本必须大于5.3. 3.界面简洁功能强大的…

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

前言 通过之前的两篇关于Swagger入门以及具体使用细节的介绍之后,我们已经能够轻松地为Spring MVC的Web项目自动构建出API文档了.如果您还不熟悉这块,可以先阅读: Spring Boot 2.x基础教程:使用Swagger2构建强大的API文档 Spring Boot 2.x基础教程:Swagger接口分类与各元素排序问题详解 在这两篇文章中,我们构建的文档必须通过在项目中整合swagger-ui.或使用单独部署的swagger-ui和/v2/api-docs返回的配置信息才能展…

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  …

在PHPer中,很多人听说过Swagger,部分人知道Swagger是用来做API文档的,然而只有少数人真正知道怎么正确使用Swagger,因为PHP界和Swagger相关的资料实在是太少了.所以鄙人斗胆一试,希望能以本文帮助到大家了解Swagger,从此告别成天用Word.Markdown折腾API文档的日子. 什么是Swagger Swagger is a simple yet powerful representation of your RESTful API. With the lar…

当我们发布一个开源项目的时候,最重要的事情之一就是要创建项目文档.对使用项目的用户来说,文档是非常有必要的,通常我们可以使用下面这些方式来创建文档: GitHub Wiki:在 Github 上我们可以为每个项目都创建一个 wiki.Wiki 是由一系列的 Markdown 文件组成,所以我们可以用 wiki 来做项目文档.但这种方案也有一些缺点:wiki 的贡献者不会出现在项目贡献者列表中:文档的结构和布局都是有限制的,只能是 Github Wikis 的样式:文档存储在第三方平台上. REA…

前言 最近公司打算做一个openapi开放平台,让我找一款好用的在线文档生成工具,具体要求如下: 必须是开源的 能够实时生成在线文档 支持全文搜索 支持在线调试功能 界面优美 说实话,这个需求看起来简单,但是实际上一点的都不简单. 我花了几天时间到处百度,谷歌,技术博客 和 论坛查资料,先后调研了如下文档生成工具: gitbook github地址:https://github.com/GitbookIO/gitbook 开源协议:Apache-2.0 License Star: 22.9k 开…

大家好,我是小富~ 前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过为了方便演示,我直接用了平台在线服务.官网地址: https://www.showdoc.com.cn/item/index 可以使用markdown语法来写API文档.数据字典文档.技术文档.在线excel文档.但像我这种资深的懒人程序员,其实更看重的是showdoc的自动化生…

前言 当我们开发需要测试接口时,会遇到以下几个问题 1.如果接口过多,参数过多,一个个参数复制到postman简直能要了我的狗命,重复劳动过多. 2.如果接口过多,参数过多,编写接口文档给测试人员或者前端,又特么要命. 于是这里安利一款idea插件easyyapi,能一键帮我们解决以上问题 GitHub地址 https://github.com/tangcent/easy-yapi 功能特性 导出API文档到Postman 导出API文档到Yapi 导出API文档到Markdown 导出RPC文…

实不相瞒我的收藏夹里躺着很多优质的开发工具,我有个爱好平时遇到感兴趣的开发工具都会记录下来,然后有时间在慢慢研究.前几天刚给同事分享一款非常好用的API文档工具,真的被惊艳到了,粉丝朋友们也感受一下吧!!! 这个 API 接口开发调试神器就是 ApiPost.你可以将其看作是 Swagger . Postman . Mock 的集合,一个工具就搞定了过去多个软件才能做的事情,避免了我们在多个软件之间来回切换,帮助咱们节省了不少事. 不仅可以一键生成 API 文档,中文,界面简洁美观,而且免费使用…

在 vite 出现以前,vuepress 是搭建组件库文档不错的工具,支持以 Markdown 方式编写文档.伴随着 vite 的发展,vitepress 已经到了 1.0.0-alpha.22 版本,很多博客还是基于 0.x 版本,1.0.0 与 0.22 配置略有差别,尤其是一些 vitepress 插件不支持 1.0.0 版本,如 vitepress-theme-demo(用它可以方便的编写组件 demo).虽然现在 1.0.0 还是 alpha 版本,咱也可以尝试使用,反正遇到什么坑就去…

Markdown文件 注意︰这是简体中国版文档的Markdown语法.如果你正在寻找英语版文档.请参阅Markdown︰ Markdown: Syntax. Markdown: Syntax 概述 哲学 行内 HTML 特殊字符自动转换 区块元素 段落和换行 标题 区块引言 清单 程序代码区块 分隔线 区段元素 连结 强调 程序代码 图片 其他 跳脱字符 自动连结 感谢 注意:这份文件是用Markdown写的,你可以看看它的原始档 . 概述 哲学 Markdown的目标是实现「易读易写」. 不过…

概述 知识与思路 代码实现 概述 Markdown 很适合于技术写作,因为技术写作并不需要花哨的排版和内容, 只要内容生动而严谨,文笔朴实而优美. 为了编写对读者更友好的文章,有必要生成文章的标题导航,让读者有个预期的阅读概览.当文章标题比较多时,手工去编写导航锚点比较费时,因此决定使用Python解析Markdown文档自动生成标题导航. 知识与思路 写过Markdown的人知道,Markdown的标题是使用一到六个# 左右包围住标题文字,而锚点是 [标题](#标题). 比如 ## 知识与思路…