message formatting.md

For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.

Message formatting

Glue uses markdown to format messages. The following features are supported:

These features are described in detail below.

Text Styling

Bold

To make text bold, wrap it with two asterisks (**) or two underscores (__). For example:

**This is bold text**
__This is also bold text__

Displays as:

This is bold text
This is also bold text

Italics

To italicize text, wrap it with one asterisk (*) or one underscore (_). For example:

*This is italic text*
_This is also italic text_

Displays as:

This is italic text
This is also italic text

Strikethrough

To strikethrough text, wrap it with two tildes (~~). For example:

~~This text is strikethrough~~

Displays as:

This text is strikethrough

Bold and Italics Combined

You can combine bold and italics for even more emphasis. For example:

***This is bold and italic text***
___This is also bold and italic text___

Displays as:

This is bold and italic text
This is also bold and italic text

Links

To create a hyperlink, use square brackets [ ] to set the text and parentheses ( ) to set the URL. For example:

[Glue](/content/site-root.html)

Displays as:

Glue

User Mentions

To mention a user in our chat app, use the following format:

[Jason Yonker](glue:usr_2PtTG7GFSgcgwfpeDOBGEQtyB24)

Displays as:

Jason Yonker

Inline Code

To include inline code, wrap your text with backticks (`). For example:

Here is some inline code: `print("Hello, World!")`

Displays as:

Here is some inline code: print("Hello, World!")

Code Blocks

For longer code snippets, use triple backticks (```), before and after your code block. You can also specify the language for syntax highlighting. For example:

```python
for i in range(10):
    print(i)
```

Displays as:

for i in range(10):
    print(i)

Blockquotes

To create a blockquote, use the greater than (>) symbol followed by a space. For example:

> This is a blockquote.

Displays as:

This is a blockquote.

Paragraphs

To create paragraphs, simply separate your text with one or more blank lines. For example:

This is the first paragraph.

This is the second paragraph.

Displays as:

This is the first paragraph.

This is the second paragraph.

Lists

Unordered Lists

To create an unordered list, use -, *, or + followed by a space. For example:

- Item 1
- Item 2
  - Subitem 1
  - Subitem 2
* Item 3
+ Item 4

Displays as:

Ordered Lists

To create an ordered list, use numbers followed by a period and a space. For example:

1. First item
2. Second item
   1. Subitem 1
   2. Subitem 2
3. Third item

Displays as:

  1. First item
  2. Second item
    1. Subitem 1
    2. Subitem 2
  3. Third item