https://github.com/ahmed-dinar/apidoc-template

A cleaner and beautiful template for apiDoc
https://github.com/ahmed-dinar/apidoc-template

api-documentation apidoc apidoc-generator apidoc-template

Last synced: 8 days ago
JSON representation

A cleaner and beautiful template for apiDoc

• Host: GitHub
• URL: https://github.com/ahmed-dinar/apidoc-template
• Owner: ahmed-dinar
• License: mit
• Created: 2019-03-11T14:48:55.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-27T06:14:00.000Z (over 3 years ago)
• Last Synced: 2024-05-21T02:53:01.799Z (6 months ago)
• Topics: api-documentation, apidoc, apidoc-generator, apidoc-template
• Language: JavaScript
• Homepage: https://ahmed-dinar.github.io/apidoc-template
• Size: 1.04 MB
• Stars: 52
• Watchers: 3
• Forks: 22
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A beautiful template for [apiDoc](https://github.com/apidoc/apidoc)

## [Live Demo](https://ahmed-dinar.github.io/apidoc-template)

##### To make example documentation

``> apidoc -i ./examples -f .route.js -o ./docs -t ./template``

![Demo screenshot](https://raw.githubusercontent.com/ahmed-dinar/apidoc-template/master/examples/assets/Screenshot1.png)

![Demo screenshot](https://raw.githubusercontent.com/ahmed-dinar/apidoc-template/master/examples/assets/Screenshot2.png)

![Demo screenshot](https://raw.githubusercontent.com/ahmed-dinar/apidoc-template/master/examples/assets/Screenshot3.png)