Skip to content

An api documentation tool generator powered by bulma and designed by Omani man.

Notifications You must be signed in to change notification settings

Moonpoll2004/doxy

Repository files navigation

Doxy Api Docs Generator

Doxy is an api generator fully powered by vite and bulma framework and Created by Oman :).

Features

  • comfortable UI.
  • it has the support for mqtt gateway/s in the doxy/docy-mqtt.json.
  • very light wight because we used vanilla js.
  • easy to use

usage

  • clone this repo:
git clone https://github.com/Moonpoll2004/doxy.git
  • run the following commands:
npm install
npm serve
  • open localhost:2400 :).
  • start editing the doxy/docy.json.
  • for mqtt API docs, edit the doxy/docy-mqtt.json.

About

An api documentation tool generator powered by bulma and designed by Omani man.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published