Callouts

Draw attention to important information with colored callout boxes.

Types

Note

Use notes for additional context or background information.

Tip

Use tips for helpful suggestions and best practices.

Important

Use important for key information that shouldn’t be missed.

Warning

Use warnings for potential issues or things to watch out for.

Danger

Use danger for critical information that could cause serious problems.

Override the default title by adding text after the type:

Compatibility Notice

This feature requires Ruby 3.2 or higher.

Before You Begin

Make sure you have completed the quickstart guide first.

Callouts support full Markdown including code blocks, lists, and links:

Installation Options

You can install Docyard globally or per-project:

# Global installation
gem install docyard

# Per-project with Bundler
bundle add docyard

See the quickstart guide for more details.

Breaking Change

The config.yml file has been renamed to docyard.yml in v2.0.

Migration steps:

Docyard also supports GitHub-style blockquote alerts:

Note

This uses GitHub alert syntax.

Tip

Helpful advice for the reader.

Important

Key information users need to know.

Warning

Something to be careful about.

Danger

Critical warning about potential issues.

:::type [optional title]
Your content here. Supports **Markdown**.
:::

GitHub alert syntax:

> [!TYPE]
> Your content here.

Type	Default Title	Use Case
`note`	Note	General information, context
`tip`	Tip	Helpful suggestions, best practices
`important`	Important	Key information not to miss
`warning`	Warning	Potential issues, cautions
`danger`	Danger	Critical problems, breaking changes

Last updated 14 minutes ago

Was this page helpful?