https://github.com/bautistaj/postman-to-markdown

Generate documentation in markdown from postman documentation.
https://github.com/bautistaj/postman-to-markdown

javascript markdown nodejs npm postman

Last synced: 3 days ago
JSON representation

Generate documentation in markdown from postman documentation.

• Host: GitHub
• URL: https://github.com/bautistaj/postman-to-markdown
• Owner: bautistaj
• License: mit
• Created: 2020-06-13T02:37:18.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-20T22:05:41.000Z (12 days ago)
• Last Synced: 2025-01-22T16:07:17.273Z (11 days ago)
• Topics: javascript, markdown, nodejs, npm, postman
• Language: JavaScript
• Homepage:
• Size: 90.8 KB
• Stars: 90
• Watchers: 2
• Forks: 25
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

![npm](https://img.shields.io/npm/v/postman-to-markdown?style=plastic)

# 📦  postman-to-markdown

This package generate markdown document from postman.

First export the collection from postman.

![Drag Racing](./resources/export_collection.png)

![Drag Racing](./resources/export.png)

Save the collection file.

## Install

```npm

npm install -g postman-to-markdown

```

# Usage

Execute postman-to-markdown specifying the collection file, now you can specify the directory where the .md file will be generated, this path is optional.

```bash

postman-to-markdown TwitterTracker.postman_collection.json /tmp

```

```

Reading file TwitterTracker.postman_collection.json

Generating markdown file ...

Documentation was created correctly /tmp/TwitterTracker.md

```

The package will create .md file.

Example of file generated [example.md](https://github.com/bautistaj/postman-to-markdown/blob/master/resources/example.md)

# Contributing

If someone wants to add or improve something, I invite you to collaborate directly in this repository: [postman-to-markdown](https://github.com/bautistaj/postman-to-markdown.git)

# License

postman-to-markdown is released under the [MIT License](https://opensource.org/licenses/MIT).