Text formatting

Text formatting is the first layer of a good implementation doc. Use plain Markdown for emphasis, links, quotes, and inline values so the reader can understand the concept before a component asks them to choose a path.

Emphasis and inline code

Use bold for the exact term or UI label the reader must notice. Use italic sparingly for emphasis, not for product names. Use inline code for package names, field names, file paths, and literal values.

Use **Offers** when the page needs checkout, pricing, and post-purchase automation.
Use `offer_id` when you pass the published offer route key to the SDK.

Links and anchors

Use descriptive links that tell the reader where they are going. Link product terms to their canonical explanation when the term might be new.

Read Offers before building a checkout page, then connect the browser SDK.

Read [Offers](/docs/offers/overview) before building a checkout page,
then connect the [browser SDK](/docs/sdk/install).

Blockquotes

Use blockquotes only for quoted product language, decision notes, or short external context. If the reader must act on the information, use a Callout instead.

Offers are the commercial object. Checkout is one surface where the offer can be sold.

> Offers are the commercial object. Checkout is one surface where the offer can be sold.

Horizontal rhythm

Do not use decorative divider lines as filler. Prefer headings, lists, or a short transition sentence. If a page feels crowded, split the teaching path with Steps or a compact Card section.

Props

Markdown text surfaces

bold**text**

Use for terms, labels, or required states the reader must notice.

italic_text_

Use for light emphasis only. Avoid styling product primitives with italics.

inline code`value`

Use for identifiers, files, props, fields, package names, event names, and literal values.

link[label](/docs/offers/overview)

Use descriptive labels. Link key concepts such as Offers, Timers, checkout sessions, and webhooks to their canonical docs pages.

blockquote> quote

Use for short quoted context. Do not hide warnings or required actions in a quote.

Related