【文件属性】:
文件名称:Quickstart:合金快速入门简介
文件大小:1.01MB
文件格式:ZIP
更新时间:2021-04-03 03:02:49
JavaScript
欢迎来到Alloy快速入门
我们创建了客户旅程的精选故事,以帮助您导航API
只需编写漂亮的API文档。
查阅。
Alloy快速入门入门
先决条件
您将需要:
对,就是那样!
设定
使用git clone https://github.com/simhskal/Quickstart.git将此存储git clone https://github.com/simhskal/Quickstart.git到您的硬盘
cd Quickstart
安装依赖项: npm install
启动测试服务器: npm run dev
现在继续访问 ,您将获得一个漂亮的示例API文档作为起点。
继续并修改source/index.md的markdown文件以适合您的需求。
发布您的API文档
发布API文档的最简单方法是在whiteboard目录中使用以下命令:
npm run generate
【文件预览】:
Quickstart-main
----source()
--------index.md(2KB)
--------includes()
--------images()
----lib()
--------whiteboard.js(365B)
----LICENSE(599B)
----Procfile(17B)
----README.md(1KB)
----.gitignore(73B)
----_config.yml(783B)
----index.js(611B)
----package-lock.json(81KB)
----package.json(830B)
----themes()
--------whiteboard()