Skip to main content

Sample contract · MD structure · ARC 2.0.0-beta.28

GFM admonition

Place GitHub-style callouts in content Markdown and inspect their real document render on the same page.

Web Device Markdown structure — not an AUP primitive; not a theme/site layout component.

Sample contract

FieldValue
PurposeAuthor static GFM admonition callouts in content Markdown
BoundariesNot editable; not AUP text full props; no write path
Author entry> [!NOTE]-style blockquotes in content.md
SurfaceWeb Device document (static)
Public statusreleased
Fallback / failureUnknown marker → ordinary blockquote; bare marker uses locale default title
VerificationRoutes below · arc --version = 2.0.0-beta.28

Purpose

GitHub-style callouts from > [!NOTE] (and TIP/IMPORTANT/WARNING/CAUTION) blockquotes.

Sample

Source (custom title on the marker line):

markdown
> [!IMPORTANT] This is a content-file capability
> Write this kind of callout in `content.md`. The page presents what the author wrote; it does not execute an action or modify data.

Rendered:

This is a content-file capability

Write this kind of callout in content.md. The page presents what the author wrote; it does not execute an action or modify data.

Bare markers (no same-line title) use the reader’s default label for the content locale. English keeps English defaults; zh defaults are applied at read time:

Markerzh default title
NOTE说明
TIP提示
IMPORTANT重要
WARNING警告
CAUTION注意

Source (bare marker):

markdown
> [!TIP]
> Prefer a same-line custom title when the English word is not the label you want.

Rendered:

Tip

Prefer a same-line custom title when the English word is not the label you want.

Failure and limits

SituationExpected result
[!FIXME] or other unknown markerPlain blockquote, not a callout chrome
Marker not on the first line of the quoteNot recognized as admonition
Expecting an editor or dismiss controlStatic document content only

Verification evidence

ItemValue
Baseline2026-08-09 · arc --version → 2.0.0-beta.28
Capability rowdocs/aup/capability-matrix.md §6 · GFM admonition
Implementationcontent-reader.ts (ADMONITION_MARKER_RE, ADMONITION_LOCALIZED_LABELS); text admonition renderer
Public routes/en/docs/web-device/markdown/gfm-admonition/ · /zh/docs/web-device/markdown/gfm-admonition/
Local runarc service start --blocklet blocklets/arcblock --port 4900 · open routes; on zh locale bare markers show Chinese defaults
AcceptSource and rendered callout match; unknown marker stays a quote; no edit controls

Related