1 Star 1 Fork 0

dongxl123 / apidoc-markdown

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

apidoc-markdown

Generate API documentation in markdown from apidoc data.

Installation

npm install apidoc-markdown

Usage

Usage: apidoc-markdown -p [path] -o [output file]

Options:
  --path, -p      Path to generated apidoc output. Where api_data.json & api_project.json resides.  [required]
  --output, -o    Output file to write.                                                             [required]
  --template, -t  Path to EJS template file, if not specified default template will be used.
  --prepend       Prepend file after TOC.

Examples

Generate from included example data

apidoc-markdown -p examples -o examples/example.md

View generated example

空文件

简介

apidoc-markdown项目,将apidoc生成的api_data.json文件转成markdown文件。 本项目是apidoc-markdown的一个分支,目标是定制开发。 展开 收起
NodeJS
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
NodeJS
1
https://gitee.com/UnlimitedBladeWorks_123/apidoc-markdown.git
git@gitee.com:UnlimitedBladeWorks_123/apidoc-markdown.git
UnlimitedBladeWorks_123
apidoc-markdown
apidoc-markdown
master

搜索帮助