Components

This page showcases every component available in the documentation system. Use it as a reference when writing new docs.

Callouts

Use callouts to draw attention to important information.

Steps

Use steps for sequential instructions.

1. First step

   This is the first thing to do. Steps can contain rich content including code blocks and callouts.

2. Second step

   Continue with the next action.

3. Third step

   Finish up here.

Cards

Use cards to link to related pages.

Property List

Use property lists to document parameters, fields, or configuration options.

Accordion

Use accordions for FAQs or optional details.

Expandable

Use expandable sections for supplementary content that shouldn't clutter the main flow.

Code Blocks

Standard code blocks come with syntax highlighting and a copy button:

const bereach = require("bereach-sdk");
 
const campaign = await bereach.campaigns.create({
  name: "Q1 Outreach",
  type: "connection_request",
  dailyLimit: 25,
});

Tables

Inline elements

Use the Badge component for inline labels: this feature requires the

Standard bold, italic, and inline code formatting works as expected.