Api Doc

API Documentation Builder

License

This project is licensed under the GNU General Public License version 3 (GPL-3.0). You can find a copy of the license at https://www.gnu.org/licenses/gpl-3.0.en.html

For commercial use, please use my contact page to obtain a commercial license.

Introduction

The Api Doc project helps to build and serve documentation using Go.

No external dependencies are required (npm, yarn, etc).

Features

• Seamless Integration: Generate documentation directly from your Go code for accuracy and efficiency.
• Reduced Overhead: Minimize the need to maintain separate applications or specification files.
• Customization and Flexibility: Tailor your documentation to your specific needs and preferences.
• Performance and Efficiency: Enjoy faster build times and reduced overhead compared to OpenAPI.
• Simplified Tooling and Reduced Dependencies: Leverage the Go ecosystem for efficient development.
• Steep Learning Curve: Benefit from a shallower learning curve if you're already proficient in Go.
• Declarative Approach: Define your API's structure and content using Go code, making it more intuitive and easier to maintain.
• Extensible: Easily add custom extensions or features to your documentation.

Supported Themes

Light Themes

• default

• cerulean

• cosmo

• flatly

• journal

• litera

• lux

• materia

• minty

• morph

• pulse

• quartz

• sandstone

• simplex

• sketchy

• spacelab

• united

• yeti

• zephyr

Dark Themes

• cyborg

• darkly

• slate

• solar

• superhero

• vapor

Credits

• UI Framework: https://getbootstrap.com
• Themes: https://bootswatch.com
• Source Highlight: https://highlightjs.org/
• Screen shots: https://www.site-shot.com