Markdown Guide

This markdown guide will not cover markdown basics such as headings. This guide will cover topics more related to Docusaurus' markdown.

Code Blocks#

To make a code block

 ``` Code block content ```

Syntax highlighting#

To enable syntax highlighting, simply add the language like so.

JSX Syntax highlighting

```jsx<View></View>```

Output

<View></View>

Code Titles#

Code titles can be very useful to define a path for the specific code

```jsx title="/src/components/example.tsx"<View></View>```

/src/components/example.tsx

<View></View>

Do note that the language is required to be able to add a title. An easy workaround if no syntax highlighting is desired is to simply input something random e.g. "NONE"

```NONE title="/src/components/example.tsx"<View></View>```

Without NONE

<View></View>

With "NONE"

/src/components/example.tsx

<View></View>

Anything works. E.g. with "efr56geye"

/src/components/example.tsx

<View></View>

Line hightlight#

It is possible to hightlight 1 or more lines

```jsx {2}<View></View><View></View><View></View>```

Output

<View></View><View></View><View></View>

Range#

```jsx {1-3}<View></View><View></View><View></View>```

Output

<View></View><View></View><View></View>

Seperated#

```jsx {1,3}<View></View><View></View><View></View>```

Output

<View></View><View></View><View></View>

tip

You can mix seperated and range highlights

```jsx {1,3-5}<View></View><View></View><View></View><View></View><View></View><View></View>```

Output

<View></View><View></View><View></View><View></View><View></View><View></View>

Admonitions#

Admonitions are like the 'tip' above.

Here is a list of all the admonitions.

:::noteSome **content** with _markdown_ `syntax`. Check [this `api`](#).:::
:::tipSome **content** with _markdown_ `syntax`. Check [this `api`](#).:::
:::infoSome **content** with _markdown_ `syntax`. Check [this `api`](#).:::
:::cautionSome **content** with _markdown_ `syntax`. Check [this `api`](#).:::
:::dangerSome **content** with _markdown_ `syntax`. Check [this `api`](#).:::