Skip to content

Latest commit

 

History

History
172 lines (143 loc) · 3.61 KB

components.md

File metadata and controls

172 lines (143 loc) · 3.61 KB

Components

Discover the components you can use in your markdown files.

Alerts

::tabs ::div

label: Preview icon: i-heroicons-magnifying-glass-circle

::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. :: :: ::div

label: Code icon: i-heroicons-code-bracket-square

::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

::tabs ::div

label: Preview icon: i-heroicons-magnifying-glass-circle

:pm-install{name="defu"}

:pm-run{script="dev"}

:pm-x{command="giget unjs new-lib"}

:: ::div

label: Code icon: i-heroicons-code-bracket-square

: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.

::tabs ::div

label: Preview icon: i-heroicons-magnifying-glass-circle

:read-more{to="/guide"} :read-more{to="https://unjs.io" title="UnJS Website"} :: ::div

label: Code icon: i-heroicons-code-bracket-square

: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.

Note

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

> [!TIP]
> Optional information to help a user be more successful.

Tip

Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

Important

Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

Warning

Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

Caution

Negative potential consequences of an action.

UI Pro

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