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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
---
layout: default
title: CommonMark Core Extension
description: The CommonMarkCoreExtension class includes all core Markdown syntax
redirect_from: /1.6/extensions/commonmark/
---
# CommonMark Core Extension
The `CommonMarkCoreExtension` class contains all of the core Markdown syntax - things like parsing headers, code blocks, links, image, etc.
## Installation
This extension is bundled with `league/commonmark`. This library can be installed via Composer:
```bash
composer require league/commonmark
```
See the [installation](/1.x/installation/) section for more details.
## Included by Default
This extension is automatically included for you (behind-the-scenes) whenever you instantiate the parser using the `CommonMarkConverter` class:
```php
use League\CommonMark\CommonMarkConverter;
$converter = new CommonMarkConverter();
echo $converter->convertToHtml('# Hello World!');
```
Or if you call the `Environment::createCommonMarkEnvironment()` helper:
```php
use League\CommonMark\DocParser;
use League\CommonMark\Environment;
use League\CommonMark\HtmlRenderer;
$environment = Environment::createCommonMarkEnvironment();
$parser = new DocParser($environment);
$htmlRenderer = new HtmlRenderer($environment);
$markdown = '# Hello World!';
$document = $parser->parse($markdown);
echo $htmlRenderer->renderBlock($document);
```
## Manual Usage
If you ever create a `new Environment()` from scratch, you'll probably want to include the `CommonMarkCoreExtension()` so you get all the standard Markdown syntax included:
```php
use League\CommonMark\Environment;
use League\CommonMark\Extension\CommonMarkCoreExtension;
use League\CommonMark\MarkdownConverter;
$environment = new Environment();
$environment->addExtension(new CommonMarkCoreExtension());
// Set your configuration if needed
$environment->mergeConfig([
// ...
]);
// Instantiate the converter engine and start converting some Markdown!
$converter = new MarkdownConverter($environment);
echo $converter->convertToHtml('# Hello World!');
```
Alternatively, if you don't want all of the core Markdown syntax, avoid using `CommonMarkCoreExtension`. You can always add just the individual parsers, renderers, etc. you actually want with the [`Environment`](/1.x/customization/environment/). (This is actually how the [Inlines Only Extension](/1.x/extensions/inlines-only/) works - it only includes a subset of things that `CommonMarkCoreExtension` does!)
|
