Sample: Shortcode Reference

Back to Getting Started.

Callouts (Boxes)

note — Note

<Note>Write your content here.</Note>

tip — Tip

<Tip>Tip content</Tip>

warning — Warning

<Warning>Points of caution</Warning>

danger — Danger

<Danger>Critical warning</Danger>

infobox — Info Box

A right-aligned box to summarize information. Pass an array of {label, value} to fields.

<Infobox
  title="Title"
  fields={[
    { label: "Field1", value: "Value1" },
    { label: "Field2", value: "Value2" },
  ]}
/>

badge — Badge

Show a small label inline.

<Badge label="Label" color="blue" />

Colors: blue green red yellow gray purple

kbd — Keyboard Shortcut

You can list multiple keys separated by +.

Press <Kbd keys="Ctrl+C" /> to copy, <Kbd keys="Ctrl+V" /> to paste.

Press Ctrl+C to copy, Ctrl+V to paste.

details — Collapsible

<Details summary="Click to expand">
Detailed content goes here.
</Details>

tooltip — Tooltip

Pass the text to display to term and the description to desc. If desc is omitted, it is automatically resolved from tooltips.json.

<Tooltip term="WikiLink" desc="A link between pages created by enclosing the page name in double brackets." />

ref • fn — Footnote

Insert a reference number in the text and place the annotation at the end of the page.

Here is a reference<Ref id="1" /> within the text.

<Fn id="1">This is the content of the footnote.</Fn>

Here is a reference ^[1] within the text.

tabs — Tabs

Create tabs using <Tabs> and <Tab label="...">. Full Markdown is supported inside tabs.

<Tabs>
<Tab label="Tab 1">

**Markdown** is supported.

</Tab>
<Tab label="Tab 2">

- Lists
- are also supported

</Tab>
</Tabs>

npm run dev

columns — Multiple Columns

Place <Col> inside <Columns>.

<Columns>
<Col>

Left column content. Markdown is supported.

</Col>
<Col>

Right column content.

</Col>
</Columns>

include — Transclusion

Embed the content of another Wiki page directly. Specify by slug.

<Include slug="getting-started" />

btn — Controller Button

Display game controller buttons as icons. Supported platforms: PS / XB / NS

Press <Btn platform="PS" button="×" /> to jump
Press <Btn platform="XB" button="A" /> to decide
Press <Btn platform="NS" button="A" /> to confirm

Press ✕ to jump
Press A to decide
Press A to confirm

navbox — Navigation Box

Calls a navigation box defined in src/data/navboxes.ts by its id.

<Navbox id="example-navbox" />

datatable — Data Table

Generates a data table from JSON in src/data/. See Sample: Datatable Demo for details.

<Datatable src="books" />

Footnotes (Content)