Skip to main content

Markdown .md

What is markdown and why its used​

Basics​

Headings​

# Level 1 title (in Docusaurus used as the page title/name)

## Level 2 title

### Level 3 title

#### Level 4 title

Bold and Italic Text​

To write bold text, wrap the text with **two asterisks**

to write italic text, wrap the text with _underline_

[Markdown Guide: Getting started](https://www.markdownguide.org/getting-started/)

Inline Code​

To use <inline code>

Wrap in backticks `, example:

To use `<inline code>`

Code blocks​

For bigger code examples you can wrap your code in code blocks 3x backticks at start and end.

    ``` 
    Example Code Block
    ```

Syntax Highlighting

if you are using a programming language like C#, you get sytnax highlighting by:

    ```csharp
    using System;

    namespace HelloWorld
    {
    class Program
    {
        static void Main(string[] args)
        {
        Console.WriteLine("Hello World!");    
        }
    }
    }
    ```
note

C-Sharp syntax highlighting is not supported by default.

To implement addtional languages refer to:

Admonitations​

wrapping text with a set of 3 colons, followed by a label denoting its type. Following Types are supported

note, tip, info, caution, danger

Example

:::danger
Some **content** with _Markdown_ `syntax`.
:::

Shows like this:

danger

Some content with Markdown syntax.

Tables​

| Syntax      | Description |
| ----------- | ----------- |
| Header      | Title       |
| Paragraph   | Text        |

Will be rendered to this:

SyntaxDescription
HeaderTitle
ParagraphText

Cell widths can vary, as shown below. The rendered output will look the same.

| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |

Its recommended to use an editor what heps with formatting.

Editors​

Editor to play around​