Components

This page demonstrates every construct the doc renderer supports. Open its source (en/contributing/components.md) side by side to see what the markdown looks like.

Text basics

Regular markdown works everywhere: bold, italic, strikethrough, inline code, highlighted, H₂O subscript and x² superscript, plus links (external links open in a new tab).

Blockquotes are for quoting text; for callouts, prefer admonitions below.

Raw HTML is intentionally not supported: it renders as plain text. Every rich element on this page is a real component instead.

That was a thematic break (---).

Lists

1. Ordered lists…
2. …stay ordered,
   • and nest bullets,
   • like this.

• Task lists render real checkboxes
• …and unchecked ones too

Definition lists document parameters nicely:

Term to define

Its definition, indented with a colon marker.

another term

Definitions can contain markdown too: emphasis, code, links.

Tables

Code

Skript code fences get the atlas highlighter and a copy button:

on message receive:
    if message content contains "hello":
        reply with "Hello %mention tag of event-user%!"

Any other language renders plain with a copy button and a language caption:

title: Components
tags: [reference]

Admonitions

The mkdocs syntax you know: !!! kind "Optional title", body indented by 4 spaces.

set {_count} to member count of event-guild

Content tabs

reply with "same feature, first variant"

Buttons

Links become buttons with the mkdocs-material attribute syntax:

Back to the docs indexPrimary button

Numbered steps

Toggles & conditional content

Pages can carry their own interactive state: toggles with ids, and ::: when blocks that show or hide based on boolean expressions over them:

retrieve member with id "123" in event-guild and store it in {_m}

Flip the toggles above; the code block follows. A full playground (inputs interpolated into code) is planned on top of this same state engine.

Referencing the atlas

Covered in depth on the next page, but the star of the show belongs here too: a one-line syntax: directive renders a live card:

The amount of detail on these cards is yours to choose in Settings → Documentation.