Write with markdown

Use headings, lists, tables, and code blocks in article bodies.

Article bodies are stored as markdown in Elmapi. This site renders that markdown for readers.

NOTE

Prefer GitHub-style callouts in body fields. Supported types: NOTE, TIP, IMPORTANT, WARNING, and CAUTION.

Headings

Use ## and deeper for structure. The page title is rendered separately, so start the body at ## when you can.

Lists and emphasis

Bullet lists for unordered steps
Numbered lists for sequences
inline code for field names and commands
Bold for UI labels

Code blocks

Fence blocks with three backticks and a language tag. Readers get syntax highlighting and a copy button.

import { createClient } from '@elmapicms/js-sdk';
 
const elmapi = createClient({
  baseUrl: process.env.ELMAPI_BASE_URL!,
  projectId: process.env.ELMAPI_PROJECT_ID!,
  apiKey: process.env.ELMAPI_API_KEY!,
});

WARNING

Never expose ELMAPI_API_KEY in client bundles. Keep it server-only.

Tables

Element	Use
Headings	Structure and TOC
Callouts	Notes and warnings
Code	Commands and samples

Tip callout

TIP

Summaries power home cards and client search. Keep them to one or two sentences.