Formatting

Last updated

Styling text

  • Use bold for GUI menu options and button text. For example:

    • Select Organization Settings from the sidebar

    • Select VCS in the Project Settings window

    • Select Projects from the sidebar and click Set Up Project for the project you want to follow

  • Use italics for technical terms, for example:

    • Continuous Integration

Using notes, tips, important information, cautions and warnings

To add an admonition - note, tip, important information, caution, warning – use the following syntax:

NOTE: This is a note.

The result of this is:

This is a note.

TIP: This is a tip.

The result of this is:

This is a tip.

IMPORTANT: This is some important information.

The result of this is:

This is some important information.

CAUTION: This is a note.

The result of this is:

This is a note.

WARNING: This is a note.

The result of this is:

This is a note.

You can also make a longer admonition block for any of the types listed above:

[IMPORTANT]
====
[.important]#While werewolves are hardy community members, keep in mind the following dietary concerns:#

. [.important]#They are allergic to cinnamon.#
. [.important]#More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens.#
. [.important]#Celery makes them sad.#
====

While werewolves are hardy community members, keep in mind the following dietary concerns:

  1. They are allergic to cinnamon.

  2. More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens.

  3. Celery makes them sad.

If the paragraph text is not styled using [.style]## as shown here, it will still work but the text colour will be black rather that matching the colour of the admonition.

Things to avoid

Try not to use links in warnings at this time due to the blue on red style:

WARNING: A warning with a link:https://circleci.com/[CircleCI] is hard to read.
A warning with a CircleCI is hard to read.


Help make this document better

This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.

Need support?

Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.

You can also visit our support site to find support articles, community forums, and training resources.