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.
Package Manager
Components to generate cross package manager comments
npm i defunpm run devnpx giget unjs new-libRead More
The component is used to create a link to another page.
Auto Code Groups
This is automatic transformation, if you have code blocks right after each other, they will be grouped together using code-group.
```ts [nuxt.config.ts]
export default defineNuxtConfig({
modules: [],
})
```
```vue [app.vue]
<template>
<h1>Hello World</h1>
</template>
```
export default defineNuxtConfig({
modules: [],
})
Steps
To generate steps all you have to do is use standard markdown numbered lists
In order to generate this component, you need to have content inside at least one of the lists. The list can't be a child of another component & also any content within a Mardown list will need at least 2 tabs to be considered as a child of the list.
1. Install Package
::note
Please note that steps only work with numbered lists and is not within children.
::
:pm-install{name="undocs"}
2. Run development server
:pm-run{script="undocs"}
3. Done ✅
1
Install Package
Please note that steps only work with numbered lists and is not within children.
npm i undocs2
Run development server
npm run undocs3
Done ✅
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.