> For the complete documentation index, see [llms.txt](https://docs.rainbird.ai/rainbird/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rainbird.ai/rainbird/knowledge-modelling/modelling-features/other-features/markdown.md).

# Markdown

Formatting can be applied to some content that is displayed to an end-user at runtime to enhance the user experience, by ensuring information is easier to read.

This formatting can be applied to the following:

1. [Question wording](/rainbird/knowledge-modelling/modelling-features/relationships/question-configuration.md#question-text)
2. [Concept instance metadata](/rainbird/knowledge-modelling/modelling-features/concepts/concept-instances.md#metadata) (can be displayed when the instance is referenced in a question or if the instance is returned as a result)

| Formatting                      | Command                                                                                                                      | Example                                                                                                                                                                                                                                                   |
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Bold                            | \*\*Bold\*\*                                                                                                                 | **Bold**                                                                                                                                                                                                                                                  |
| Italic                          | \_Italic\_                                                                                                                   | *Italic*                                                                                                                                                                                                                                                  |
| Header 1                        | # Header 1                                                                                                                   | <h2>Header 1</h2>                                                                                                                                                                                                                                         |
| Header 2                        | ## Header2                                                                                                                   | <h3>Header 2</h3>                                                                                                                                                                                                                                         |
| Header 3                        | ### Header 3                                                                                                                 | <h4>Header 3</h4>                                                                                                                                                                                                                                         |
| Numbered list                   | <p>1. Item 1<br>2. Item 2</p>                                                                                                | <ol><li>Item 1</li><li>Item 2</li></ol>                                                                                                                                                                                                                   |
| Bullet list                     | <p>-Item 1</p><p>    - Item 1a<br>-Item 2<br>    - Item 2a<br><br><strong>Note</strong>: Indent requires 4 spaces or tab</p> | <ul><li><p>Item 1</p><ul><li>Item 1a</li></ul></li><li><p>Item 2</p><ul><li>Item 2a</li></ul></li></ul>                                                                                                                                                   |
| Inline link with title on hover | \[Click here!]\(<https://www.google.co.uk> "Google")                                                                         | <img src="https://2183467111-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FehfnPLAHSx4uHugNiyth%2Fuploads%2FWxdWros11SlsZOuvoe0P%2Fimage.png?alt=media&amp;token=34490522-2284-4072-b38f-cdf887689a5d" alt="" data-size="original"> |
| Link without title              | \[Click here]\(<https://www.google.co.uk>)                                                                                   | [Click here](https://www.google.co.uk)                                                                                                                                                                                                                    |

{% hint style="info" %}
Rainbird agents will display the markdown formatting for question wording and instance metadata by default.

If implementing a custom solution, it is recommended to discuss these display requirements with your development team.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.rainbird.ai/rainbird/knowledge-modelling/modelling-features/other-features/markdown.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.