https://github.com/devhammed/insomnia-plugin-documenter

Export Insomnia workspace HTML documentation.
https://github.com/devhammed/insomnia-plugin-documenter

api documentation documentation-generator insomnia insomnia-plugin insomnia-plugins workspace

Last synced: 5 months ago
JSON representation

Export Insomnia workspace HTML documentation.

• Host: GitHub
• URL: https://github.com/devhammed/insomnia-plugin-documenter
• Owner: devhammed
• License: mit
• Created: 2020-10-04T16:15:23.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-08T09:59:39.000Z (about 2 years ago)
• Last Synced: 2024-12-06T01:34:09.995Z (6 months ago)
• Topics: api, documentation, documentation-generator, insomnia, insomnia-plugin, insomnia-plugins, workspace
• Language: JavaScript
• Homepage: https://insomnia.rest/plugins/insomnia-plugin-documenter
• Size: 608 KB
• Stars: 27
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# insomnia-plugin-documenter

Export Insomnia workspace HTML documentation.

## How it Works?

The plugin provides a workspace action labelled `Export HTML Documentation...`,

on click it will ask for the output path

(you only have to type this once for each workspace as the plugin remembers the last output path 🤭🤭🤭)

and there is support for `~` paths, e.g. `~/dev/AwesomeProject/docs`,

but if you did not provide one it defaults to your `Desktop` folder with a folder named by your workspace slug

(e.g. `Grant Master` becomes `Grant-Master-API-Docs`).

After exporting, you will see a success message that contains path to the

generated docs folder and it is ready to be deployed anywhere that support static HTML hosting

(e.g. GitHub Pages, Vercel, and Netlify).

## Credits

- Insomnia Documenter CLI tool (https://github.com/jozsefsallai/insomnia-documenter)