Formatting Annotations

Formatting Annotations

This page explains how you can format your annotations to have special appearances.

Markdown Support

Annotations support most of the markdown syntax.

Headings

You can define headings in your annotation using #, with one appearing for each level of heading. So # is an <h1> and ### is an <h3>. The limit is ###### (6).

Example

# Heading ## Heading 2

Bold Text

Text surrounded in ** will be bolded.

Example

**Bold text!**

Italic Text

Text surrounded in * will be italicized.

Example

*italicized text*

Struckthrough Text

Text surrounded in ~~ will be struck through.

Example

Three strikes and you're ~~in~~ out

Ordered List

To create an ordered list, just start counting with each item on a new line. Each item should start with a number followed by a period and then a space.

Example

1. Item 1
2. Item 2

Unordered List

To create an unordered list, place a * or - before each list element, with each list element appearing on a new line.

Example

- Item 1
- Item 2

Blockquote

Text beginning with a > will be turned into a blockquote. This will result in it being indented.

Example

> My quoted text

Code

To make a small piece of code stand out, place it in backticks `.

Example

`myVariable`

Code Block

To insert a larger snippet of Lua code, you can start and end a code block with 3 backticks ```.

Example

```
function()
    print("Hello!")
end
```

Horizontal Rule

To add a horizontal divide/rule, use *** or --- on its own line.

Example

Something
---
divided

Link

To add a link, place the alt text in square brackets with the url immediately following in parentheses.

Example

[GitHub Repository](https://github.com/LuaLS/lua-language-server)

Image

To add an image, place a !, followed by the alt text in square brackets, with the url immediately following in parentheses.

Example

![Huskies in the snow](https://upload.wikimedia.org/wikipedia/commons/thumb/7/7a/Huskiesatrest.jpg/2880px-Huskiesatrest.jpg)

New line

There are many ways to add newlines to your annotations.

The most bulletproof way is to simply add an extra line of just ---, although this functions like a paragraph break, not a newline.

The below methods can be added to the end of a line:

• HTML <br> tag (recommended)
• Two trailing spaces
• \n new line escape character
• Markdown backslash \ (Not recommended)