1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
---
layout: default
title: Basic Usage
description: Basic usage of the CommonMark parser
---
# Basic Usage
The `CommonMarkConverter` class provides a simple wrapper for converting Markdown to HTML:
```php
require __DIR__ . '/vendor/autoload.php';
use League\CommonMark\CommonMarkConverter;
$converter = new CommonMarkConverter();
echo $converter->convertToHtml('# Hello World!');
// <h1>Hello World!</h1>
```
Or if you want GitHub-Flavored Markdown:
```php
require __DIR__ . '/vendor/autoload.php';
use League\CommonMark\GithubFlavoredMarkdownConverter;
$converter = new GithubFlavoredMarkdownConverter();
echo $converter->convertToHtml('# Hello World!');
// <h1>Hello World!</h1>
```
<i class="fa fa-exclamation-triangle"></i>
**Important:** See the [security](/1.4/security/) section for important details on avoiding security misconfigurations.
[Additional customization](/1.4/customization/overview/) is also possible, and we have many handy [extensions](/1.4/extensions/overview/) to enable additional syntax and features.
## Supported Character Encodings
Please note that only UTF-8 and ASCII encodings are supported. If your Markdown uses a different encoding please convert it to UTF-8 before running it through this library.
|
