{"id":16616892,"url":"https://github.com/sebastienrousseau/pm2md","last_synced_at":"2025-10-29T19:31:20.352Z","repository":{"id":49406319,"uuid":"517637902","full_name":"sebastienrousseau/pm2md","owner":"sebastienrousseau","description":"Postman2Markdown (PM2MD) is a package that generates markdown documentation from a Postman collection file","archived":false,"fork":false,"pushed_at":"2023-10-19T13:42:53.000Z","size":955,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T04:31:48.646Z","etag":null,"topics":["markdown","postman","postman-documentation"],"latest_commit_sha":null,"homepage":"http://pm2md.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sebastienrousseau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/funding.yml","license":"LICENSE","code_of_conduct":".github/CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null},"funding":{"github":"sebastienrousseau","custom":"https://paypal.me/wwdseb"}},"created_at":"2022-07-25T11:30:41.000Z","updated_at":"2023-11-09T12:56:56.000Z","dependencies_parsed_at":"2023-02-09T02:01:19.081Z","dependency_job_id":null,"html_url":"https://github.com/sebastienrousseau/pm2md","commit_stats":{"total_commits":16,"total_committers":2,"mean_commits":8.0,"dds":0.0625,"last_synced_commit":"35e6d2e42f679f4c95bd334f1c491661aaa7dc87"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastienrousseau%2Fpm2md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastienrousseau%2Fpm2md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastienrousseau%2Fpm2md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sebastienrousseau%2Fpm2md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sebastienrousseau","download_url":"https://codeload.github.com/sebastienrousseau/pm2md/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238882235,"owners_count":19546466,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","postman","postman-documentation"],"created_at":"2024-10-12T02:14:34.946Z","updated_at":"2025-10-29T19:31:19.973Z","avatar_url":"https://github.com/sebastienrousseau.png","language":"TypeScript","funding_links":["https://github.com/sponsors/sebastienrousseau","https://paypal.me/wwdseb"],"categories":[],"sub_categories":[],"readme":"# Postman2Markdown (PM2MD)\n\n[![logo][pm2md]][0]\n\n\n[![codacy][codacy]][9]\n[![contributors][contributors-shield]][contributors-url]\n[![forks][forks-shield]][forks-url]\n[![license](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge\\\u0026color=ff69b4)][4]\n![made with love][7]\n[![npm](https://img.shields.io/npm/v/@sebastienrousseau/pm2md.svg?style=for-the-badge\\\u0026color=f14041)](https://www.npmjs.com/package/@sebastienrousseau/pm2md)\n\n**[Website][0] • [Documentation](https://pm2md/docs/)\n• [Report Bug](https://github.com/sebastienrousseau/pm2md/issues)\n• [Request Feature](https://github.com/sebastienrousseau/pm2md/issues)\n• [Contributing Guidelines](https://github.com/sebastienrousseau/pm2md/blob/master/.github/CONTRIBUTING.md)**\n\n***\n\n## Welcome to Postman2Markdown (PM2MD)\n\nPostman2Markdown (PM2MD) is a package that generates markdown documentation from\na Postman collection file. It simplifies the process of converting your Postman\ncollections into well-structured and readable documentation.\n\n## Getting Started with Development\n\nBefore you begin, make sure you have downloaded [Postman][1] and installed\nit on your computer. Alternatively, you can use the [web version][2] of Postman.\n\n- Export your Postman collection.\n\n![Drag Racing][5]\n\n- Save the collection file to your local directory.\n\n![Drag Racing][6]\n\n## Install\n\nYou can install Postman2Markdown globally using npm:\n\n```bash\nnpm install -g pm2md\n```\n\n## Usage\n\nTo generate markdown documentation from a Postman collection, run the following\ncommand in your terminal, specifying the path to your collection file:\n\n```bash\npm2md postman_collection.json\n```\n\n```bash\nReading file examples/postman_collection.json\nGenerating markdown file ...\nDocumentation was created correctly examples/postman_collection.md\n\n```\n\nThis will read the specified Postman collection file, generate the corresponding\nmarkdown documentation, and save it as an `.md` file.\n\nExample of file generated\n[postman_collection.md](examples/postman_collection.md)\n\n## Versioning \u0026 Updates\n\nAdhering to [semantic versioning](http://semver.org/) ensures consistent\nupdates. Refer to\n[GitHub Releases](https://github.com/sebastienrousseau/pm2md/releases) for the\nchangelog.\n\n## How to Contribute\n\nYour contributions can make this guide even better! Check our\n[Contributing Guidelines](https://github.com/sebastienrousseau/pm2md/blob/main/.github/CONTRIBUTING.md)\nto get started.\n\n## Community \u0026 Values\n\nJoin a community that values diversity and inclusivity. Familiarize yourself\nwith our [Code of Conduct](https://github.com/sebastienrousseau/pm2md/blob/main/.github/CODE-OF-CONDUCT.md).\n\nOur beliefs:\n\n- Perfection encompasses everything.\n- Passion transcends code.\n- Obsession with excellence in solutions.\n\n## Licensing\n\nThis project embraces the MIT License. View [LICENSE details](LICENSE).\n\n## Shoutouts \u0026 Credits\n\n[PM2MD][0] is a masterpiece crafted by\n[Sebastien Rousseau](https://sebastienrousseau.com) and other incredible\n[contributors][contributors-url].\n\nCrafted with ❤ in London.\n\n[codacy]: https://img.shields.io/codacy/grade/f20b5f4e5e6649a9a4ec25df87b6dc08?style=for-the-badge \"codacy\"\n[contributors-shield]: https://img.shields.io/github/contributors/sebastienrousseau/pm2md.svg?style=for-the-badge \"contributors\"\n[divider]: https://raw.githubusercontent.com/sebastienrousseau/pm2md/master/assets/divider.svg \"divider\"\n[forks-shield]: https://img.shields.io/github/forks/sebastienrousseau/pm2md.svg?style=for-the-badge \"forks\"\n[pm2md]: https://raw.githubusercontent.com/sebastienrousseau/pm2md/master/assets/pm2md-logo.svg \"Postman2Markdown (PM2MD)\"\n[logo]: https://kura.pro/pm2md/images/banners/pm2md.webp \"Postman2Markdown (PM2MD)\"\n\n[0]: https://pm2md.com\n[1]: https://www.postman.com/downloads/\n[2]: https://www.postman.com/\n[3]: https://www.npmjs.com/package/@sebastienrousseau/pm2md\n[4]: https://opensource.org/licenses/MIT\n[5]: https://raw.githubusercontent.com/sebastienrousseau/pm2md/master/resources/export_collection.png\n[6]: https://raw.githubusercontent.com/sebastienrousseau/pm2md/master/resources/export.png\n[7]: https://raw.githubusercontent.com/sebastienrousseau/pm2md/master/assets/made-with-love.svg\n[8]: https://coveralls.io/github/sebastienrousseau/pm2md?branch=main\n[9]: https://app.codacy.com/gh/sebastienrousseau/pm2md/\n[forks-url]: https://github.com/sebastienrousseau/pm2md/network/members\n[contributors-url]: https://github.com/sebastienrousseau/pm2md/graphs/contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsebastienrousseau%2Fpm2md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsebastienrousseau%2Fpm2md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsebastienrousseau%2Fpm2md/lists"}