使用Spec Markdown 编写手册文档

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 spec-md --dev
package.json
{
"name": "first",
"version": "1.0.0",
"main": "index.js",
"license": "MIT",
"dependencies": {
"spec-md": "^0.6.0"
},
"scripts": {
"b": "spec-md ./md/*.md > ./out/index.html",
"live":"live-server --open=./out"
},
"devDependencies": {
"live-server": "^1.2.0"
}
}
md/userlogin.md

构建&&运行

  • 构建
yarn b
  • 访问
yarn live
  • 效果

参考资料

http://leebyron.com/spec-md/
https://github.com/rongfengliang/spec-md-demo

原文地址:https://www.cnblogs.com/rongfengliang/p/9441028.html

时间: 2024-10-22 05:43:11

使用Spec Markdown 编写手册文档的相关文章

Markdown编写接口文档模版

接口名称 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) 请求返回结果参数说明

[API]使用Blueprint来高雅的编写接口文档

Blueprint(http://apiary.io/)是apiary公司的工具包,用来编写API文档,类似于Markdown,是一种标记语言. 对于习惯使用RESTful API的同志们来说,使用Blueprint可以快速的写出高雅大气的文档: 下面以一个Github中的Gist服务为例,简单的演示一下Blueprint的应用. 原文地址:http://blog.callmewhy.com/2014/06/05/blueprint-tutorial/ API Blueprint是一套API描述

Win10环境下,告别MarkdownPad,用Notepad++搭建编写md文档的环境

1. 为什么抛弃MarkdownPad 2 ? MarkdownPad坊间号称 Windows 环境下最好用的markdown编辑器-EXO me??? 博主入MarkdownPad 2 坑就是因为这个坊间口碑,但是使用起来并不舒心-原因如下: 笨重,每次打开md文档都需要等待软件启动 无法预览效果,需要安装额外的软件Awesomium 打开文档,预览显示一片空白也是常事 2. Notepad++ 免费 轻量 插件众多 台湾同胞开发 支持众多语言风格的展示(可以集成编辑各类文档) 3. 搭建编写

向架构师进军--->如何编写软件架构文档

如果你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",加入这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的好处是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构可以提供追溯其他工作产品的上下文. 有文档的架构可以传达可供选择的架构解决方案. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构可以提醒架构师在其所作的某些决定背后的

向架构师进军--->怎样编写软件架构文档

假设你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",增加这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的优点是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构能够提供追溯其它工作产品的上下文. 有文档的架构能够传达可供选择的架构解决方式. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构能够提醒架构师在其所作的某些决定背后的

开发底层硬件应该怎么编写接口文档

开发底层硬件应该怎么编写接口文档 这几天在做超市RFID结算系统的上位机程序编写,用的是VB.NET.底层用的是别人开发好的SDK,为什么要写这一篇文章呢?最近因为手头设备的功能限制,我就在网上找其他的公司的RFID射频卡读写器,由于我是做上层开发,所以需要设备供应商提供底层SDK二次开发包,找了好多设备提供商 ,也跟他们索取各自提供的SDK,但总的来说,我还是觉得最先用的这个设备的厂家提供的SDK是最详细的,现在简单说明如下: 一.函数说明: 1.目录结构清晰: 2.函数返回值,参数用表格说明

使用 Laravel-Swagger 编写接口文档(php)

使用 Laravel-Swagger 编写接口文档 Table of Contents Swagger 文档管理 官方网站:https://swagger.io/ 快速编写你的 RESTFUL API 接口文档工具,通过注释定义接口和模型,可以和代码文件放置一起,也可以单独文件存放. 优势 通过代码注解定义文档,更容易保持代码文档的一致性 模型复用,减少文档冗余,带来更可靠的文档 提供客户端访问接口,可以直接调试接口,不需要第三方工具进行调用测试接口 支持权限认证,等功能 Laravel Swa

vue mint ui 手册文档对于墙的恐惧

npm 安装 推荐使用 npm 的方式安装,它能更好地和 webpack 打包工具配合使用. npm i mint-ui -S CDN 目前可以通过 unpkg.com/mint-ui 获取到最新版本的资源,在页面上引入 js 和 css 文件即可开始使用. <!-- 引入样式 --><link rel="stylesheet" href="https://unpkg.com/mint-ui/lib/style.css"><!-- 引入

程序员编写技术文档的新手指南

这是一篇帮助你给第一个项目写文档的指南. 万事开头难,我希望这份指南能把你引导到正确的道路上. 最后,你应该有一个可以公开发布的项目. 请轻松地阅读完这篇文章,或者简单地把它当作参考. 为什么要写文档? 你将会在 6 个月后使用你的代码 我发现一开始从利己的角度来解释这个问题会比较有吸引力.写文档最好的理由就是你将会在 6 个月后使用你的代码.你 6 个月前写的代码跟别人写的代码对你来说通常没有什么区别.你将会带着一种熟悉的感觉读你的代码.然后一种不良的预兆悄悄逼近,你发现写代码的人毫无经验,毫