> For the complete documentation index, see [llms.txt](https://docs.pullrequest.com/the-pullrequest-reviewer-tools/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pullrequest.com/the-pullrequest-reviewer-tools/markdown-syntax-guide.md). # Markdown Syntax Guide ## Code ### Inline ``` This is ``! ``` ### Block ```` ``` function square(number) { return number * number; }; function(2); ``` ```` ### Block with syntax highlighting ```` ```javascript function square(number) { return number * number; }; function(2); ``` ```` ## Links ``` https://www.pullrequest.com - automatic [PullRequest Website](https://www.pullrequest.com) - with anchor text ``` ## Images ``` ![Img Alt Text](https://www.website.com/image-file.jpg) ``` ## Emphasis ``` *This text will be bold* _This text will be italic_ ~~This text will have strikethrough applied~~ ``` ## Headers ``` # For

## For

### For

... and so on ``` ## Blockquotes ``` > It was the best of times, > it was the worst of times. ``` ## Tables ``` Column1 Header | Column2 Header ------------ | ------------- Column1 Row1 | Column2 Row1 Column1 Row2 | Column2 Row2 Column1 Row3 | Column2 Row3 ``` ## Lists ### Unordered ``` * Item 1 * Item 2 * Item 3 ``` ### Ordered ``` 1. Item 1 2. Item 2 3. Item 3 ``` ## HTML ``` BOLD TEXT ``` Note: Using `<>` may cause contained characters not to render. --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.pullrequest.com/the-pullrequest-reviewer-tools/markdown-syntax-guide.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.