1.0.4 • Published 6 years ago
markdown-swagger v1.0.4
Installation
npm install markdown-swagger
Usage
markdown-swagger ./api/swagger/swagger.yaml ./README.md
This will read the specified swagger file and generate a table describing the API inside the target markdown file.
The markdown-swagger
script will look for the for the following piece of text inside the target markdown file to do its stuff:
<!-- markdown-swagger -->
Everything here will be replaced by markdown-swagger
<!-- /markdown-swagger -->