https://brikev.github.io/express-jsdoc-swagger-docs/
express-jsdoc-swagger generator documentation
https://brikev.github.io/express-jsdoc-swagger-docs/
hacktoberfest
Last synced: 5 months ago
JSON representation
express-jsdoc-swagger generator documentation
- Host: GitHub
- URL: https://brikev.github.io/express-jsdoc-swagger-docs/
- Owner: BRIKEV
- Created: 2020-06-01T20:43:53.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T18:13:41.000Z (almost 2 years ago)
- Last Synced: 2024-08-03T17:08:14.193Z (9 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage: https://brikev.github.io/express-jsdoc-swagger-docs/
- Size: 716 KB
- Stars: 3
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Security: docs/security.md
Awesome Lists containing this project
- awesome-docsify - express-jsdoc-swagger - Node.js library for generating Swagger OpenAPI 3.x UI. (Showcase)
README
# express-jsdoc-swagger-docs
This repository has the docs with Docsify of [express-jsdoc-swagger](https://github.com/BRIKEV/express-jsdoc-swagger) and [express-oas-validator](https://github.com/BRIKEV/express-oas-validator).
## How to run this project
This project uses [Docsify](https://docsify.js.org/). You have to install Docsify client cli.
```
npm i docsify-cli -g
```
Then execute:
```
npm start
```
This will be running in `localhost:3000`.
```
Serving /Users/kevinccbsg/brikev/express-jsdoc-swagger-docs/docs now.
Listening at http://localhost:3000
```
## Deployment
You only need to do a PR or merge it in the master branch.