Configuration Builder

Configure the look and behaviour of your API documentation with this builder. Instead of editing periwinkle.config.ts by hand, you assemble it visually from settings that speak for themselves.

Only the settings you change from their defaults are written to the config file. periwinkle then reads that file when it builds your API documentation, and your changes take effect in the generated reference.

Once everything looks the way you want, copy the whole config file to your clipboard, or save it straight into your API reference project.

Every option is documented in CONFIGURATION.md. This builder runs entirely in your browser; nothing is uploaded.

Settings

This is the OpenAPI 3.x contract that periwinkle renders. Point it at a local JSON or YAML file, and every endpoint, schema, and description in the reference is generated from it.

This section defines the identity of the generated site. You set its title, the base path the site is served under, the server URL shown in the code examples, and the favicon.

This section controls the visual design of the reference. Here you choose the light and dark colour palettes, the heading, body, and monospace fonts, and the global corner radius.

This section configures the sticky top bar and the affordances it shows. You can enable a brand logo, the home link, the search trigger, a GitHub link, and the theme toggle.

This section configures the left navigation rail. You decide whether it carries its own search field and how its collapsible sections behave.

This section holds the global switches for optional affordances. Each switch turns a part of the reference on or off, such as the OpenAPI contract viewer, the access badge, and the copy buttons.

This section sets the typography scale and the layout dimensions. It defines the body, code, and heading sizes together with the spacing that controls the overall density of the reference.

This section controls the animation of the interface. It sets the timing of the collapsible sections and transitions, together with the intensity of the color-mix effects used across the UI.

This section controls the integration guide panel. Auto derives the guide from your spec, Custom lets you write your own Markdown, and Off hides the panel entirely.

This section lets you add your own Markdown chapters. Each chapter is inserted into the reference at a position you choose, either before or after the integration guide.

This section configures the footer that appears at the bottom of every page. You set its links and its closing line of text.

Configuration Preview

Reset all fields?

This clears every value and restores the built-in periwinkle defaults. It cannot be undone.