Code Blocks

Sheriff supports both inline code and multi-line code blocks.

Code formatting should be used whenever you want to show commands, source code, configuration files, terminal output, or examples that should be displayed exactly as written.

Inline Code

Wrap text in backticks to create inline code.

What you write:

Use `:say()` to print text.

What it does:

Use :say() to print text.

Inline code is useful for:

• Functions
• Commands
• File names
• Keywords
• Small snippets

Examples:

The `repeat` loop executes a block multiple times.

Run `goblin build` to build your project.

Edit `config.yall` to change site settings.

Code Blocks

For larger examples, use triple backticks.

What you write:

What it does:

console.log("Hello");

console.log("Hello");

This allows Sheriff to apply syntax highlighting when supported by the active theme.

Common examples:

What it does:

repeat 1...5 as n
    :say(n)
xx

repeat 1...5 as n
    :say(n)
xx

This enables Goblin-specific syntax highlighting in Sheriff.

When to Use Inline Code vs Code Blocks

Use inline code for short references:

Use `repeat` to loop.

Use code blocks for examples:

• Keep code blocks focused on a single concept.
• Prefer several small examples over one giant example. Even when syntax highlighting is optional, specifying the language makes your documentation easier to read and maintain.