Start Building for Free

Using lists

1+ year ago1 min read
  • To generate numbered steps (an ordered list) use the following syntax:

    . step 1 text
    . step 2 test
    . step 3 text
  • To keep numbered steps flowing correctly when code blocks, images or admonitions are used inside steps, use the + on the line before the block starts to indicate the block is part of the step above:

      . Step one
      . Step two involves some code
      [source, shell]
      some code
      . Step three is still in number order
  • Use ordered lists for steps in a process. All other lists should be unordered.

  • Capitalize the first word of each item in a list.

  • If the text in the bullet is a full sentence or completes the intro stem use a period at the end.

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.