easy-postman2md v1.0.0

📦 easy-postman2md

The easiest way to generate a markdown document from postman.

Install

npm install -g easy-postman2md

Usage

1. First export the collection from postman.

2. Save the collection file.

3. Execute easy-postman2md specifying the collection file and optionally the template

easy-postman2md \                         # name of the package
  sample.postman_collection.json \        # Postman file
  [template.ejs] \                        # (Optional) Template to use
  [output-file-name.md]                   # (Optional) The output file name

Reading file sample.postman_collection.json
Generating markdown file ...
Documentation successful  sample.md

Reading file sample.postman_collection.json

Generating markdown file ...

Documentation was created correctly sample.md

The package will create .md file.

Build your own template.

This packages implements EJS templates, you can find documentation in the following link

<%= EJS %>

Template sample is here Default template

Contributing

If someone wants to add or improve something, I invite you to collaborate directly in this repository: easy-postman2md

How to run the npm

• Clone the repository.
• Install dependencies.
• Make your changes.
• Run the command npm run start <path of the postman file> [<path of template>].
• Happy programming

Status

Project: in progress Thank you for using this NPM

Stay in touch

• Author - Luis Arias 2021 <ariassd@gmail.com> GitHub profile

License

This software is licensed under MIT License

May 2021