UnDocs logoUnDocs
Guide

Components

Discover the components you can use in your markdown files.


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.
::note
Highlights information that users should take into account, even when skimming.
::
::tip
Optional information to help a user be more successful.
::
::important
Crucial information necessary for users to succeed.
::
::warning{to="/"}
Critical content demanding immediate user attention due to potential risks.
::
::caution{to="/"}
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
:pm-install{name="defu"}

:pm-run{script="dev"}

:pm-x{command="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. 
:read-more{to="/guide"}
:read-more{to="https://unjs.io" title="UnJS Website"}

Github Notes

https://github.com/orgs/community/discussions/16925

> [!NOTE]
> Highlights information that users should take into account, even when skimming.
Highlights information that users should take into account, even when skimming.
> [!TIP]
> Optional information to help a user be more successful.
Optional information to help a user be more successful.
> [!IMPORTANT]
> Crucial information necessary for users to succeed.
Crucial information necessary for users to succeed.
> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.
Critical content demanding immediate user attention due to potential risks.
> [!CAUTION]
> Negative potential consequences of an action.
Negative potential consequences of an action.

UI Pro

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

Edit this page on GitHub

Getting Started

Content Transformation

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