Overview

This area shows how duxt turns different source files into pages. The OpenAPI reference, the Bruno collection, the demo changelog and the Terraform provider share this area's section row, while each uses the layout suited to its content.

Harbour is an API this site made up. It moves consignments through berths, it has four versions, and — one endpoint aside — nothing answers on any of them.

It exists to be rendered: every construct OpenAPI 3.1 has that is awkward to draw is somewhere in these documents, so the reference pages duxt builds are exercised by a real build rather than described in a test.

The demo changelog is a separate fixture, with feature, fix and breaking-change entries and several heading levels. Compare its release pages and version sidebar with the same file rendered as one continuous page. These sample versions are not releases of the duxt package.

#Where to start

• OpenAPI — the reference: the overview, then a page per tag and a page per operation.
• Book a consignment — two request bodies, a callback and a Location header.
• Book a demo consignment — the one operation that is real. A route in www/server/ answers it, so the try-it client sends a request from your browser and gets a 201 back.
• Bruno — the same API as a Bruno collection, one page per request.
• Changelog — a release overview, with a page per version and a version sidebar.
• Changelog as one page — the same release history, showing the flat changelog layout.
• Terraform — a real provider reference, read as it comes out of tfplugindocs.