Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoppscotch/hopp-doc-gen
📔 API documentation generator CLI for https://hoppscotch.io
https://github.com/hoppscotch/hopp-doc-gen
api api-request cli command-line-app command-line-tool documentation hoppscotch javascript markdown nodejs postwoman static-site-generator
Last synced: 20 days ago
JSON representation
📔 API documentation generator CLI for https://hoppscotch.io
- Host: GitHub
- URL: https://github.com/hoppscotch/hopp-doc-gen
- Owner: hoppscotch
- License: mit
- Created: 2019-12-09T08:26:20.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-08-21T22:04:00.000Z (over 1 year ago)
- Last Synced: 2025-01-03T05:19:59.714Z (28 days ago)
- Topics: api, api-request, cli, command-line-app, command-line-tool, documentation, hoppscotch, javascript, markdown, nodejs, postwoman, static-site-generator
- Language: JavaScript
- Homepage: https://hoppscotch.io
- Size: 1.2 MB
- Stars: 129
- Watchers: 6
- Forks: 15
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hopp Doc Gen
An API documentation generator CLI by https://hoppscotch.io
---
## Installation
```bash
$ npm install -g hdg
```
Or, with `npx`
```bash
$ npx hdg generate
```
## Usage
```bash
Usage: hdg [options]
An API documentation generator CLI
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
generate [options] Generate API Documentation
help [command] display help for command
```
## Generate API Doc
```bash
Usage: hdg generate [options]
Generate API Documentation
Options:
-s, --skip-install skip installation of vuepress and just create the markdown file
-o, --output-path specify an output path (default: "docs")
-r, --request-buttons add a request button for each GET request
-h, --help display help for command
```
`path` - path to `hoppscotch-collection.json` exported from [hoppscotch.io](https://hoppscotch.io/)
## Contributing Guidelines
- Clone the repository.
- Navigate to the directory and install dependencies with `npm install`.
- Now fire in `npm link` which creates a symlink and now `hdg` can be accessed globally.
## Instructions
_Hopp Doc Gen generates documentation (using Vuepress) based on Hoppscotch collections._
**1.** Navigate to https://hoppscotch.io/doc and export a collection. (by clicking on the `Import/Export` button in the Collections pane).
**2.** Then generate documentation using the following command:
```
$ npx hdg generate hoppscotch-collection.json
```
**3.** To preview your generated documentation, run
```
$ npm run docs:dev
```
**4.** **Deploying to Netlify!!!**
Once you feel like you're ready to publish the documentation, you can deploy it on Netlify.
To deploy your documentation to Netlify, you'll have to build the files first.
```
$ npm run docs:build
```
**5.** At this point, you need to create a GitHub repo to deploy your documentation on Netlify. So create a GitHub repo and give it an awesome name!
**6.** Then, push the documentation folder to your GitHub repo.
```
$ git remote add origin https://github.com/USERNAME/NAME_OF_REPO_WHERE_DOCUMENTATION_IS_TO_BE_DEPLOYED
$ git add .
$ git commit -m "generate api doc"
$ git push -u origin master
```
**7.** Once you're logged in at https://netlify.com, create a new site by clicking on `New Site from Git`. Choose your Git provider and then choose your awesome repo where the awesome documentation is located!
**8.** Under the **Basic Build Settings**, set build command as `npm run docs:build` and set the publish directory as `docs/.vuepress/dist`.
**9.** And then click on **Deploy Site**! And _hopefully_, Netlify should build your documentation and make it live! :partying_face:
**10.** Congratulations, you have successfully deployed your documentation on Netlify!