Api2html
A CLI tool to transform Swagger/OpenAPI/AsyncAPI docs to beautiful HTML pages via Shins/Widdershins.
Overview
api2html is a CLI (Command Line Interface) tool that allows you to transform Swagger/OpenAPI/AsyncAPI documents into visually appealing HTML pages using Shins/Widdershins. It provides the ability to generate custom HTML pages from these documents, making it easier to document and showcase APIs.
Features
- Transform Swagger/OpenAPI/AsyncAPI docs to HTML pages
- Ability to render different types of documents, such as OpenAPI v3 files, with customizable options
- Supports custom logo integration for personalized branding
- Language examples can be generated based on preference, such as go and javascript
- Customizable syntax highlighter options, including the ability to use different highlight.js themes
- Resolve external dependencies by enabling the use of refs to external files
Summary
api2html is a powerful CLI tool that simplifies the process of transforming Swagger/OpenAPI/AsyncAPI documents into visually appealing HTML pages. With features like custom logo integration, language example generation, and customizable syntax highlighter options, api2html offers flexibility and ease of use for generating API documentation. It also allows for the resolution of external dependencies, making it a versatile tool for working with API documentation.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.