Skip to content

Custom Containers#

View Markdown

::: type containers are opt-in. GitHub-style > [!NOTE] callouts stay on the default renderer path and do not require this option.

Option Type Default
containers boolean / ContainerOptions false
import { oxContent } from "@ox-content/vite-plugin";

export default {
  plugins: [
    oxContent({
      containers: true,
    }),
  ],
};

Built-in types#

tip, note, info, important, warning, danger, caution, and details.

::: tip
Install the plugin first.
:::

::: warning Watch out
This changes rendered markup.
:::

::: details{open}
Optional extra context.
:::

Titles can be written as ::: tip Title or ::: tip[Title]. Attributes accept #id, .class, and the boolean open flag on details.

Custom types#

oxContent({
  containers: {
    types: {
      cli: { title: "CLI" },
      spoiler: { title: "Spoiler", tag: "details" },
    },
  },
});

Type names must be ASCII identifiers. Hostile names and attributes are dropped.

Last updated: