PM2MD
Website • Documentation • Report Bug • Request Feature • Contributing Guidelines
Welcome to Postman2Markdown (PM2MD)
This package generates generates a markdown documentation from a Postman collection file.
Getting Started with Development
👉 Before you begin: » Make sure you have downloaded Postman and installed it on your computer. Alternatively, you can sign up to use the web version of Postman.
- First export the collection from Postman.
- Save the collection file.
Install
npm install -g pm2md
Usage
Execute pm2md specifying the collection file.
pm2md postman_collection.jsonReading file examples/postman_collection.json
Generating markdown file ...
Documentation was created correctly examples/postman_collection.md
The package will create an .md file.
Example of file generated postman_collection.md
Semantic Versioning Policy
For transparency into our release cycle and in striving to maintain backward
compatibility, pm2md follows semantic versioning
and ESLint's Semantic Versioning Policy.
Changelog
Code of Conduct
We are committed to preserving and fostering a diverse, welcoming community. Please read our Code of Conduct.
Our Values
- We believe perfection must consider everything.
- We take our passion beyond code into our daily practices.
- We are just obsessed about creating and delivering exceptional solutions.
Contributing
Thank you for using PM2MD! If you like the library, it would be great if you can give it a star ⭐ on [GitHub][17].
There are also many ways in which you can participate in this project, for example:
- Submit bugs and feature requests, and help us verify as they are checked in,
- Review source code changes, and help us improve our code quality,
- Review the documentation and make pull requests for anything from typos to additional and new content.
Please read carefully through our Contributing Guidelines for further details on the process for submitting pull requests to us.
License
Copyright (c) Sebastien Rousseau. All rights reserved.
Licensed under the MIT license.
Acknowledgements
PM2MD is beautifully crafted by these people and a bunch of awesome contributors.
| Contributors |
|---|
 |
| Sebastien Rousseau |