Skip to content

Style Guide

Last updated View as MarkdownAgent setup

Use this guide whenever you write or review Cloudflare content, whether it lives in the documentation or in the product dashboard. Following it is what keeps the whole site reading as though one careful author wrote every page, which also makes the content clearer for readers and simpler to translate.

The guide is organized around the way you actually work, in five stages: contribute a change, plan the content, write it in the Cloudflare style, build the page, and, for the Cloudflare team, run the site.

Contribute

Start here. Make a change and get it merged.

Contributions

Open an issue or raise a pull request, then follow it through the review that merges it.

Plan your content

Decide what kind of page you are writing and where it lives.

Content strategy

Choose a content type, structure the page, and place it in the information architecture.

API content

Follow the conventions for documenting endpoints, parameters, and resources.

Style and grammar

Write the page in the house voice, grammar, and formatting.

Grammar

Apply the rules for parts of speech, punctuation, and capitalization.

Formatting

Format dates, numbers, code, lists, tables, and UI elements consistently.

Build the page

Author the page in MDX, set its metadata, and add components.

Markdown and MDX

Learn the MDX syntax, how to import components, and how to escape special characters.

Frontmatter

Declare the required and optional metadata that every page carries.

Components

Assemble pages from the MDX components that add buttons, tabs, and more.

How we docs

How the Cloudflare team runs the site. This section is Cloudflare-specific internal process.

How we docs

See how the team handles the site framework, redirects, links, metadata, AI, and video.

Was this helpful?