Guide

Components

Discover the components you can use in your markdown files.

Undocs is currently intended for UnJS docs only and is not fully customizable yet.
Contributions are more than welcome but please consider that this project is not ready yet to be used.
Make sure to use Bun and WSL for Windows. We don't guarantee stability yet and it is expected that it doesn't work time to time.

Alerts

Highlights information that users should take into account, even when skimming.

Optional information to help a user be more successful.

Crucial information necessary for users to succeed.

Critical content demanding immediate user attention due to potential risks.

Negative potential consequences of an action.

Package Manager

Components to generate cross package manager comments

npm i defu

npm run dev

npx giget unjs new-lib

Read More

The component is used to create a link to another page.

Read more in Guide.

Read more in UnJS Website.

UI Pro

You can use all the Prose components from Nuxt UI Pro in your markdown files.

Edit this page (some contents are generated with automd from source)

Getting Started

Content Transformation

Discover ways that undocs transforms content to make it more easier to just write documentation.