Anchore Style Guide

This guide specifies the preferred Markdown syntax and formatting rules for consistency throughout the Anchore documentation corpus.

Docsy shortcode information can be found here: https://www.docsy.dev/docs/adding-content/shortcodes

1. Headings and Structure

Use ATX-style headings (using #) for all titles and section headers. Ensure there is a single space between the # and the heading text.

Use section breaks to separate H2 headings (using -–).

Use active voice (imperative) in headers:

• e. g. Import SBOMs instead of Importing SBOMs

LLM Notes and Tips: Prospects use LLMs to shortlist products and understand our capabilities before engaging with Anchore. H1, H2, and H3 headings help LLMs better incorporate our content into answers.

• Expose key features in H2 and H3 headers.
• Use language in headings and introductions that makes sense to readers who are not yet familiar with how Anchore works.

Rule	Style	Example
H1 (Page Title)	Use a single # (reserved for the page title, usually generated by the documentation system).	# Page Title
H1 Introduction	Always ensure a page introduction is found below the H1 Page Title Tip: Include context for people who may not understand how Anchore works yet.	# Page Title This page introduces the AnchoreCTL command-line (CLI) utility.
H2 (Major Section)	Use ##. Should be used for the main sections within the page.	## Installation and Setup
H3 (Subsection)	Use ###. Should be used for sub-topics within a section.	### Using AnchoreCTL
H4 (Detail/Procedural)	Use ####. Should be used for steps or minor divisions.	#### Step 1: Configure URL
Capitalization	Use Title Case (capitalize major words) for all headings.	## Generating SBOMs using AnchoreCTL
Spacing	Include a blank line before and after every heading to ensure proper rendering and source readability.

2. Text Formatting and Emphasis

Ensure consistency in ways to emphasise text and call-out mechanisms.

Element	Style	Example	Recommended Use
Bold	Use double asterisks (**).	Should be avoided at all times.	Strong emphasis on important key words.
Italics	Use single asterisks (*).	*optional* or *recommended*	Light emphasis, parenthetical notes, variables, or words/phrases that need differentiation.

3. Image Formatting

Ensure consistency in how images are presented.

Element	Style	Example	Recommended Use
Image	imgproc	{{< imgproc results.png Resize “700x” >}} Ready for download! {{< /imgproc >}}	Use the imgproc shortcode to do in-line processing and resizing, generally size images between 400x and 700x Avoid using “ex” or “example” and just use plain text.

4. Code, Commands, and File Paths

Code formatting is crucial for technical documentation and example snippets.

Element	Style	Example
Individual Command Names or File Names	Command names, file names (config.yaml), file types (JSON, YAML), function/API names, variable names.	`anchorectl`
Command-Line & Code Blocks (Fenced)	Use triple backticks (````` `` `) with a language specifier. Always include a language specifier where possible (e.g., `bash`, `yaml`, `json`, `text`).	```bash docker login -u <your_dockerhub_pat_user> -p <your_dockerhub_pat> ```

5. Lists

Use consistent markers for lists and ensure proper indentation for nested items.

Element	Style	Example
Unordered Lists	Use hyphens (-) for all top-level unordered lists. Do not mix hyphens, asterisks (*), and plus signs (+).	- First bullet point - Second bullet point - Third bullet point
Ordered Lists	Start every ordered list with 1. The Markdown renderer handles the rest

6. Tables

To add a table in Markdown, use the vertical line | to separate each column, and use three or more dashes -– to create each column’s header. A vertical line should also be added at either end of the row.

Element	Style	Example
Tables	Use hyphens (-) for all top-level unordered lists. Do not mix hyphens, asterisks (*), and plus signs (+).	`
Text Alignment	:– means the column is left aligned. --: means the column is right aligned. :-: means the column is center aligned.

7. Notes, Warnings and Admonitions

Ensure consistent formatting for callouts and warnings to users.

Element	Style	Example
Alert	color: Use this parameter to specify one of Bootstrap’s predefined alert variants, each of which has their own color. These include primary, info, and warning Avoid the use of title	{% alert color="warning" %} Docker Compose is only recommended for testing (e.g. demo or proof-of-concept) or small deployments. For all other usage patterns, customers should use a Helm-based deployment on K8s which enables easier scaling, modular deployment and fine-grained configuration.{% /alert %}

8. Product and Branding

Ensure consistent product and feature naming.

Element	Style	Example
Anchore Enterprise	Refer to the core product as “Anchore Enterprise” and not just “Anchore” or “Enterprise”	Use Anchore Enterprise to enforce a POA&M

Last modified December 5, 2025