It's been a while since I started working on express-autodocs, A GitHub action that generates documentation by scanning express APIs.
Today I would like to gladly share the first public version of the action with the DEV community 🎉🎊
prafulla-codes
/
express-autodocs
A GitHub action which automatically generates documentation for your express APIs.
💡 Introduction
This action automatically scans for express APIs in your codebase and generates a documentation website
Whats New?
- Added JSDOC Like Syntax to define APIs (Thanks to @rahil1304)
- Refactored Code & Reduced Bugs (Thanks to @rosborne132 & @KulkarniSuraj)
- Added Unit Tests
How to add to your workflow ❔
To add this action to your workflow simply modify your workflows main.yml file.
# This is a basic workflow to help you get started with Express AutoDocs Action
name: Express AutoDocs.
# This specifies when the action should occur
on:
push:
branches: [master]
jobs:
generate_docs_job:
runs-on: ubuntu-latest
name: Generating Docs
steps:
# this step checks out the master branch of your repo using checkout action.
- name: Checks out the repository
id: checksout-repository
uses: actions/checkout@v2
with:
repository: ''
# this step generates the docs…Here is the working demo:
✅ Tested on Repository
Processing Output
Outputs
docs/readme.md
docs/pages/api-items.md
Top comments (0)