- Home
- Documentation Generators
- Widdershins
On the recordRead 4 Oct 202612 facts
Widdershins
Plans and prices
Widdershins
Free
Open source MIT-licensed software · install via npm or clone the repository
Read 4 Oct 2026 · github.com
On the record
- API use
- Widdershins can be called from Node.js using its convert function, which returns a Promise.github.com · read 4 Oct 2026
- Code samples
- It supports customizable code samples, including language tabs, and can use httpsnippet to generate samples.github.com · read 4 Oct 2026
- Input formats
- The project describes support for OpenAPI 3.x, OpenAPI 2.0, API Blueprint, AsyncAPI, and Semoasa inputs.github.com · read 4 Oct 2026
- Install
- The project can be installed globally with npm install -g widdershins or installed by cloning the repository and running npm i.github.com · read 4 Oct 2026
- Integrations
- The README describes using Widdershins with Slate, ReSlate, Shins, and ReSpec renderers.github.com · read 4 Oct 2026
- License
- The repository identifies its license as MIT.github.com · read 4 Oct 2026
- Limits
- Schema examples default to a maximum depth of 10, and referenced request body schemas are not expanded by default unless they have an inline schema.github.com · read 4 Oct 2026
- Output formats
- Widdershins can produce Markdown and can also output HTML directly or use ReSpec format.github.com · read 4 Oct 2026
- Pipeline
- It is intended as a stage in an API documentation pipeline, converting API definitions for a renderer.github.com · read 4 Oct 2026
- Purpose
- Widdershins converts OpenAPI, Swagger, AsyncAPI, and Semoasa definitions into Markdown compatible with Slate and ReSlate.github.com · read 4 Oct 2026
- Security
- The README documents generated Authorization headers in OpenAPI code samples and provides an option to customize the API key value.github.com · read 4 Oct 2026
- Templates
- Users can customize output by editing or overriding the included templates.github.com · read 4 Oct 2026