Skip to content

3.2.0

Choose a tag to compare

@jeffersonrucu jeffersonrucu released this 15 Aug 20:17
· 10 commits to master since this release

Minor release. Adds interactive API documentation to the Docsify page, bundled with the plugin.

Added

API reference with Swagger UI. A Markdown page holding a link named swagger is replaced by the interactive documentation for the specification it points at:

[swagger](api/openapi.json)

The path is resolved from the documentation folder, so an API reference lives beside the rest of the docs and is written the same way. An absolute URL works too, when the API hosts its own file.

OpenAPI files served under the access rule. JSON, YAML and YML are handed out by the file endpoint, so a specification stays behind the same role check as the page it belongs to, instead of being readable by direct URL.

Swagger UI bundled with the plugin. Version 5.32.11, Apache-2.0, no CDN request — the same rule every other asset in the plugin already follows.

Changed

The API reference follows the documentation, not the stock Swagger look. It picks up the theme color from the settings and the typography of the page, its tables drop the boxed grid, code samples use a light theme matching Docsify's own, and the loading state is a plain spinner instead of the uppercase LOADING label Swagger prints inside it.

The reference is mounted next to .markdown-section rather than inside it. Docsify styles every table, heading and code token within that element, and those rules were landing on Swagger's markup — the parameter and response tables in particular came out with a heavy grid and misread inline code as syntax highlighting.

README rewritten. The project structure was missing most of the source files, the admin settings screen was not covered, and the screenshots showed screens that no longer exist. Screenshots are now captured from the plugin as it runs today.

Notes

Nothing changes on existing documentation. The API reference only appears on pages that link to an OpenAPI file.

Try it out sends the request from the visitor's browser, so the API has to allow the documentation origin through CORS.

Install

Download docsify-docs-3.2.0.zip and upload it under Plugins > Add New Plugin > Upload Plugin. Do not unzip it first.

Full Changelog: v3.1.1...v3.2.0

🤖 Generated with Claude Code