Components

Discover every component you can use in your content.

<Alert />

Check out an info alert with code and a link.
Check out a success alert with code and a link.
Check out a warning alert with code and a link.
Check out a danger alert with code and a link.
MDC
::alert{type="info"}
Check out an **info** alert with `code` and a [link](/).
::

::alert{type="success"}
Check out a **success** alert with `code` and a [link](/).
::

::alert{type="warning"}
Check out a **warning** alert with `code` and a [link](/).
::

::alert{type="danger"}
Check out a **danger** alert with `code` and a [link](/).
::

<Badge />

<Badge /> support same types as <Alert />.

v1.2DeprecatedNot found!
MDC
:badge[v1.2]

:badge[Deprecated]{type="warning"}

::badge{type="danger"}
Not found!
::

<BlockHero />

MDC
::block-hero
---
cta:
  - Get started
  - /get-started
secondary:
  - Open on GitHub →
  - https://github.com/nyxb/docux
snippet: npx nyxbi@latest init docux-app -t nyxb/docux-starter
---
#title
Document-driven framework

#description
Docux reconciles content creators and developers by offering to both the best tools to create and scale content-based websites.
::

MDC
:button-link[Play on StackBlitz]{icon="IconStackBlitz" href="https://stackblitz.com/github/nyxb/docux-starter" blank}

<Callout />

<Callout /> support same types as <Alert />.

This is the content of the callout.
This is the content of the callout.
MDC
::callout
#summary
This is a callout! Click me to open.

#content
This is the content of the callout.
::
 
::callout{type="warning"}
#summary
This is a callout! Click me to open.

#content
This is the content of the callout.
::

<Card />

Nuxt Architecture.

Based on Nuxt 3 and Nuxt Content.
Use Nuxt to build a static site, or a serverless app.

MDC
 ::card{icon="logos:nuxt-icon"}
 #title
 Nuxt Architecture.
 #description
 Based on **Nuxt 3** and **Nuxt Content**. :br
 Use Nuxt to build a static site, or a serverless app.
 ::

<CardGrid />

Nuxt Architecture.

Harness the full power of Nuxt and the Nuxt ecosystem.

Vue Components.

Use built-in components (or your own!) inside your content.

Write Markdown.

Enjoy the ease and simplicity of Markdown and discover MDC syntax.

MDC
::card-grid
#title
What's included

#default
  ::card
  #title
  Nuxt Architecture.
  #description
  Harness the full power of Nuxt and the Nuxt ecosystem.
  ::
  ::card
  #title
  Vue Components.
  #description
  Use built-in components (or your own!) inside your content.
  ::
  ::card
  #title
  Write Markdown.
  #description
  Enjoy the ease and simplicity of Markdown and discover MDC syntax.
  ::
::

<CodeGroup />

This component uses slots to create a tab panel of your code examples or preview.

Yarn
yarn add docux
NPM
npm install docux
MDC
::code-group
  ```bash [Yarn]
  yarn add docux
  ```
  ```bash [NPM]
  npm install docux
  ```
::

<CodeBlock />

To be used inside a <CodeGroup /> component to display a preview of some rendered code.

Hello World!
MDC
/* Added as a child of `<CodeGroup />` */

::code-preview{label="Preview" preview}
  ::badge
  Hello World!
  ::
::

<Icon />

Icon component gives you access to all 100,000+ icons from icones.js.org.

MDC
:icon{name="logos:nuxt-icon"}
:icon{name="logos:vue"}
:icon{name="logos:nuxt-icon"}

<List />

  • Important
  • Always
  • Amazing
  • Congrats
  • Do you know?
  • You can also do this
  • Be careful
  • Use with precautions
  • Drinking too much
  • Driving drunk
MDC
::list{type="primary"}
- **Important**
- Always
::

::list{type="success"}
- Amazing
- Congrats
::

::list{type="info"}
- Do you know?
- You can also do this
::

::list{type="warning"}
- Be careful
- Use with precautions
::

::list{type="danger"}
- Drinking too much
- Driving drunk
::

<Sandbox />

Embed CodeSandbox/StackBlitz easily in your documentation with great performances.

Using the IntersectionObserver to load when visible in the viewport.

Loading Sandbox...
MDC
:sandbox{src="https://codesandbox.io/embed/nuxt-content-l164h?hidenavigation=1&theme=dark"}

<Terminal />

Bash
>nuxi build
Click to copy
MDC
:terminal{content="nuxi build"}

<VideoPlayer />

MDC
::div
  :video-player{src="https://www.youtube.com/watch?v=o9e12WbKrd8"}
::

Edit this page on GitHub
Table of Contents