Markdown formatting

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

Starlight extends Markdown with admonitions (asides), heading links, and MDX so authors can mix prose with components — a common pattern for SaaS docs (Notion-style clarity, developer-portal depth).

Admonitions (asides)

Use these for onboarding notes, breaking changes, security warnings, and support escalations.

Markdown directive syntax works too:

Tables (plans, matrices, SLAs)

Tier	Support	SLA	SSO
Evaluate	Community + docs	Best effort	Optional
Business	Email, 8×5	99.5%	SAML/OIDC
Enterprise	Named CSM, 24×7	99.9%	SAML/OIDC + SCIM

Lists and checklists

Ordered setup (release notes, upgrade paths):

Provision tenant in DIH admin.
Create connector credentials.
Register webhook endpoints.
Run connectivity test from the console.

Unordered capabilities (feature marketing in docs):

Multi-tenant isolation
Audit log export
EU data residency options

Task checklist (implementation guides):

Create Keycloak client
Configure redirect URIs
Assign product access groups in Keycloak (see access matrix)

Blockquotes and definitions

Good documentation answers: who is this for, what will they achieve, and what do they need before they start?

Connector : A governed integration endpoint that exchanges assets and events between your systems and the DIH platform.

Data space : A contractual and technical boundary for sharing data under agreed policies.

Code in prose

Inline Authorization: Bearer <token> and paths like /assets/{assetId} stay readable without a full code block.

Images and figures

Figures can include captions (accessibility and SEO). Hero imagery on the home page uses the official DIH diamond from production docs.

When to reach for MDX

Need	Markdown	MDX
Policy / legal text	✅
Tabbed SDK samples		✅ `<Tabs>`
Embedded demo or API		✅ custom components
Auto-generated OpenAPI		✅ embed or link

Next: Starlight components for layout primitives.