Authoring Content in Markdown
Guidelines for contributing to the RoboCup documentation, specifically on the formatting of elements.
Official Documentation
Section titled “Official Documentation”The official documentation is the most reliable source for all syntax-related questions. You can find it here.
Code blocks
Section titled “Code blocks”A code block is indicated by a block with three backticks ``` at the start and end. You can indicate the programming language being used after the opening backticks.
More information can be found in the official documentation.
Examples
Section titled “Examples”```// Insert code here```// Insert code hereAsides
Section titled “Asides”Asides (also known as “admonitions” or “callouts”) are useful for displaying secondary information alongside a page’s main content.
Starlight provides a custom Markdown syntax for rendering asides. Aside blocks are indicated using a pair of triple colons ::: to wrap your content, and can be of type note, tip, caution or danger.
You can nest any other Markdown content types inside an aside, but asides are best suited to short and concise chunks of content.
More information can be found in the official documentation.
Syntax
Section titled “Syntax”:::tip[Example]Asides can be used to highlight important information, or fun-facts!:::Examples
Section titled “Examples”:::note[Notes]This is a note aside.::::::tip[Tips]This is a tip aside.::::::caution[Cautions]This is a caution aside.::::::danger[Dangers]This is a danger aside.:::Standards
Section titled “Standards”Dangerous Activity
Section titled “Dangerous Activity”Whenever potentially hazardous activities are referenced, such as the use of high voltages, they must be clearly marked with a danger aside.
:::danger[High Voltage]This section discusses procedures involving high voltages. Incorrect handling may result in serious injury or death. Reader discretion is advised.:::Irreversible Action
Section titled “Irreversible Action”Whenever potentially irreversible actions are referenced, such as drilling permanent holes or modifying PCB traces, they must be clearly marked with a caution aside.
:::caution[Irreversible Action]This action is irreversible. Proceed only if you are certain.:::AI-Generation
Section titled “AI-Generation”All AI-generated portions should come with a disclaimer.
:::caution[AI-Generated]This documentation is currently under active development. The content on this page has been generated by an AI model as a temporary placeholder. Please exercise discretion while reading, as information is being added and refined regularly. Thank you for your understanding and patience.:::Important Information
Section titled “Important Information”All pages containing important notices and disclaimers should be clearly indicated.
:::caution[Important]The following section contains important notices and disclaimers. Readers are strongly advised to read it carefully before proceeding.:::