Postman2Markdown (PM2MD) is a package that generates markdown documentation from a Postman collection file
OTHER License
Website • Documentation • Report Bug • Request Feature • Contributing Guidelines
Postman2Markdown (PM2MD) is a package that generates markdown documentation from a Postman collection file. It simplifies the process of converting your Postman collections into well-structured and readable documentation.
Before you begin, make sure you have downloaded Postman and installed it on your computer. Alternatively, you can use the web version of Postman.
You can install Postman2Markdown globally using npm:
npm install -g pm2md
To generate markdown documentation from a Postman collection, run the following command in your terminal, specifying the path to your collection file:
pm2md postman_collection.json
Reading file examples/postman_collection.json
Generating markdown file ...
Documentation was created correctly examples/postman_collection.md
This will read the specified Postman collection file, generate the corresponding
markdown documentation, and save it as an .md
file.
Example of file generated postman_collection.md
Adhering to semantic versioning ensures consistent updates. Refer to GitHub Releases for the changelog.
Your contributions can make this guide even better! Check our Contributing Guidelines to get started.
Join a community that values diversity and inclusivity. Familiarize yourself with our Code of Conduct.
Our beliefs:
This project embraces the MIT License. View LICENSE details.
PM2MD is a masterpiece crafted by Sebastien Rousseau and other incredible contributors.
Crafted with ❤ in London.