Skip to main content

Formatting your logs

Colm Doyle avatar
Written by Colm Doyle
Updated over 3 weeks ago

Who doesn't love a bit of formatting?

When writing your logs in Clonra, you can choose to format them with Markdown.

Supported Markdown Elements

Headers

We support three levels of heading, which you can create by adding the relevant number of # symbols:

# Heading 1 ## Heading 2 ### Heading 3

Styling Text

Bolding text is done by wrapping it in double asterisks **:

**This text is bolded**

Example: This text is bolded

Italics

Italicizing text is done by wrapping it in underscores _:

_This text is italicized_

Example: This text is italicized

Links

You can create hyperlinks by using square brackets [] for the link text and parentheses () for the URL:

[Visit Clonra](https://www.clonra.com)

Example: Visit Clonra

Inline Code

To format inline code, wrap the text in single backticks `:

`inline code`

Example: inline code

Code Blocks

To format code blocks, use triple backticks ``` around your code snippet:

``` def example(): print("Hello, Clonra!") ```

Example:

def example(): print("Hello, Clonra!")

Blockquotes

Use > to format blockquotes:

> This is a quoted text.

Example:

This is a quoted text.

Ordered Lists

Create ordered (numbered) lists using numbers followed by periods:

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

Example:

  1. First item

  2. Second item

  3. Third item

Unordered Lists

Create unordered lists using dashes -, plus signs +, or asterisks *:

- Item one - Item two - Item three

Example:

  • Item one

  • Item two

  • Item three

Happy formatting!

Did this answer your question?