Spec Markdown 是一个基于markdown 的文档编写工具，安装简单，可以让我们编写出专业的文档

参考项目

安装

• 全局

npm install -g spec-md

• 本地项目依赖

npm install --save-dev spec-md

项目使用

因为个人原因，比较喜欢使用yarn，所以项目基于yarn 初始化

• 初始化

yarn init -y

• 配置构建&&依赖

yarn add spec-md --devpackage.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 文档

  参考github 项目

md/userlogin.md

构建&&运行

• 构建

yarn b

• 访问

yarn live

• 效果
  

参考资料