Markdown Support

LaRecipe automatically leverages Markdown to HTML parser out of the box.

Basics

Markdown elements automatically parsed into normal HTML tags.

Typography

Input:

### H3

Output:

H3


Images

Input:

![image](url)

Output:

cute image


Inline Code

Input:

Inline code is `cool`

Output:

Inline code is cool


Code

LaRecipe uses prism.js with code highlighting out of the box. LaRecipe supports all Prism supported languages.

Input:

```php
echo 'LaRecipe is beautiful';
```

Output:

echo 'LaRecipe is beautiful';

Tables

Markdown Tables automatically parsed and converted to nice looking rendered tables.

Input: 

| # | Name   | Age |
| : |   :-   |  :  |
| 1 | Saleem | 24  |
| 2 | John   | 25  |
| 3 | Ayman  | 26  |

Output:

# Name Age
1 Saleem 24
2 John 25
3 Ayman 26

Alarms

LaRecipe provides beautiful looking alerts parsed directly from Markdown with extra sugar, all that you have to do is to prepend Markdown blockquote with {type} of your alert.

The supported alarms types are: primary, success, info, danger, warning.

Input: 

> {danger} Here is an example of danger alarm message

Output:

{danger} Here is an example of danger colored alarm

You are also able to use font-awesome icons in alarms.

Input: 

> {danger.fa-close} Here is an example of a font awesome icon

Output:

{danger.fa-close} Here is an example of a font awesome icon

Table of Content

By default, LaRecipe is considering the first ul element in your docs file as the table of content and it will appear on the top-right corner of your documentation for quick navigation.

{primary} Each link in your table of content will be targeted to the corresponding h2 element in your documentation file.

- [Example](#example-link)

<a name="example-link">
## [Example](#example-link)