Parsedown

https://github.com/erusev/parsedown
Admin
A fast and extensible Markdown parser library for PHP with support for GitHub Flavored Markdown.
Tokens:7,732
Snippets:77
Trust Score:8.9
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install Parsedown via Composer

Source: https://github.com/erusev/parsedown/blob/master/readme.md

Install the Parsedown package using Composer. This is the recommended installation method.

```sh
composer require erusev/parsedown
```

--------------------------------

### Basic usage with new Parsedown()

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Get-Started

Demonstrates using the constructor to create a Parsedown instance and then calling text(). The output is the same as the static method example.

```php
$Parsedown = new Parsedown();

echo $Parsedown->text('Hello _Parsedown_!'); 

# Output:
# <p>Hello <em>Parsedown</em>!</p>
```

--------------------------------

### PHP Hello World Example

Source: https://github.com/erusev/parsedown/blob/master/test/data/code_block.html

A basic PHP script that assigns a string to a variable and echoes it. Used to test Parsedown's rendering of a standard PHP code block.

```php
<?php

$message = 'Hello World!';
echo $message;

```

--------------------------------

### Enable automatic line breaks with setBreaksEnabled

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Get-Started

Sets the setBreaksEnabled option to true to convert newlines to <br /> tags. The example shows the output with a line break.

```php
echo Parsedown::instance()
   ->setBreaksEnabled(true) # enables automatic line breaks
   ->text("1st line \n 2nd line"); 

# Output:
# <p>1st line <br /> 2nd line</p>
```

--------------------------------

### Parse Markdown text with Parsedown

Source: https://github.com/erusev/parsedown/blob/master/readme.md

Create a Parsedown instance and use the text() method to convert Markdown to HTML. The example prints '<p>Hello <em>Parsedown</em>!</p>'.

```php
$Parsedown = new Parsedown();

echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
```

--------------------------------

### PHP code block with message

Source: https://github.com/erusev/parsedown/blob/master/test/data/code_block.md

A simple PHP code block that assigns a string to a variable and echoes it. This is a basic example of a code block in Markdown.

```php
<?php

$message = 'Hello World!';
echo $message;
```

--------------------------------

### Parse inline Markdown only with Parsedown

Source: https://github.com/erusev/parsedown/blob/master/readme.md

Use the line() method to parse inline Markdown without block-level elements. The example prints 'Hello <em>Parsedown</em>!'.

```php
echo $Parsedown->line('Hello _Parsedown_!'); # prints: Hello <em>Parsedown</em>!
```

--------------------------------

### Basic usage with Parsedown::instance()->text()

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Get-Started

Shows the simplest way to parse Markdown to HTML using the static instance method. The output is a paragraph with emphasized text.

```php
echo Parsedown::instance()->text('Hello _Parsedown_!'); 

# Output:
# <p>Hello <em>Parsedown</em>!</p>
```

--------------------------------

### Basic usage with new instance

Source: https://github.com/erusev/parsedown/wiki/Usage

Create a new Parsedown instance and call text() to parse Markdown. The output is shown in a comment.

```php
$Parsedown = new Parsedown();

echo $Parsedown->text('Hello _Parsedown_!'); # would print <p>Hello <em>Parsedown</em>!</p>
```

--------------------------------

### Parse a file with file_get_contents

Source: https://github.com/erusev/parsedown/wiki/Usage

Include Parsedown.php, read a Markdown file, and parse its contents. The output is shown in comments.

```php
include('Parsedown.php');
$file = file_get_contents('FILE.md');
$Parsedown = new Parsedown();

echo $Parsedown->text($file);

# Output: *Whatever content your file has inside!*
# *I used this tutorial to learn this: (https://dcblog.dev/reading-markdown-files-with-parsedown) *
```

--------------------------------

### Add Multi-Line Bold Element in Parsedown Extension

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Create-Extensions

Extends the bold element (**) to work across multiple lines by registering a new block type and implementing blockBoldText, blockBoldTextContinue, and blockBoldTextComplete. The constructor adds 'BoldText' to BlockTypes for the '*' character. The continue method appends lines until a closing '**' is found, and the complete method returns the final block.

```php
class Extension extends Parsedown
{

    /**
     * The array index is the first character of the pattern to match.
     * It is not possible to define patterns longer than one character directly here, as only the first
     * character of the line will be checked. (eg. Setting $this->BlockTypes['{tag'] won't work.)
     *
     * The second array is a list of all functions that should be called when the character is found.
     *
     * Leave out the 'block' or 'inline' part of the function name, as it will be prepended automatically.
     */
    function __construct()
    {
        $this->BlockTypes['*'][] = 'BoldText'; 
    }

    protected function blockBoldText($line, $block)
    {
        if (preg_match('/^\*\*/', $line['text'], $matches))
        {
            return array(
                'char' => $line['text'][0],
                'element' => array(
                    'name' => 'strong',
                    'text' => '',
                ),
            );
        }
    } 

    /**
     * Appending the word `continue` to the function name will cause this function to be
     * called to process any following lines, until $block['complete'] is set to be 'true'.
     */
    protected function blockBoldTextContinue($line, $block)
    {
        if (isset($block['complete']))
        {
            return;
        }

        // A blank newline has occurred.
        if (isset($block['interrupted']))
        {
            $block['element']['text'] .= "\n";
            unset($block['interrupted']);
        }

        // Check for end of the block. 
        if (preg_match('/\*\*/', $line['text']))
        {
            $block['element']['text'] = substr($block['element']['text'], 1);

            // This will flag the block as 'complete':
            // 1. The 'continue' function will not be called again.
            // 2. The 'complete' function will be called instead.
            $block['complete'] = true;
            return $block;
        }
        
        $block['element']['text'] .= "\n" . $line['body'];
        
        return $block;
    }

    /**
     * Appending the word `complete` to the function name will cause this function to be
     * called when the block is marked as *complete* (see the previous method).
     */
    protected function blockBoldTextComplete($block)
    {
        return $block;
    }

}
```

--------------------------------

### Prepend Base Path to Image src in Parsedown Extension

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Create-Extensions

Overrides inlineImage to call the parent method and then prepend a base path to the src attribute. The base path is stored in a private property. This approach can be applied to other element types.

```php
class Extension extends Parsedown
{

    private $baseImagePath = 'http://cdn.example.com/';

    protected function inlineImage($excerpt)
    {
        $image = parent::inlineImage($excerpt);

        if ( ! isset($image))
        {
            return null;
        }

        $image['element']['attributes']['src'] = $this->baseImagePath . $image['element']['attributes']['src'];

        return $image;
    }

}
```

--------------------------------

### Enable safe mode for untrusted input

Source: https://github.com/erusev/parsedown/blob/master/readme.md

Call setSafeMode(true) to tell Parsedown to process untrusted user-input, escaping user-input within generated HTML and sanitising scripting vectors. Safe mode does not guarantee safety when using extensions.

```php
$Parsedown->setSafeMode(true);
```

--------------------------------

### Change Image Element Markup to Prepend Base Path

Source: https://github.com/erusev/parsedown/wiki/Writing-Extensions

Overrides inlineImage to prepend a base path to the src attribute of image elements. The base path is stored in a private property and concatenated with the original src.

```php
class Extension extends Parsedown
{
    private $baseImagePath = 'http://cdn.example.com/';

    protected function inlineImage($Excerpt)
    {
        $Image = parent::inlineImage($Excerpt);

        $Image['element']['attributes']['src'] = $this->baseImagePath . $Image['element']['attributes']['src'];

        return $Image;
    }
}
```

--------------------------------

### Code block with blank lines

Source: https://github.com/erusev/parsedown/blob/master/test/data/code_block.md

A code block that contains blank lines. It shows that blank lines within an indented block are preserved.

```markdown
foo


bar
```

--------------------------------

### Escape markup with setMarkupEscaped

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Get-Started

Sets the setMarkupEscaped option to true to escape HTML tags in the input. The output shows escaped tags and parsed Markdown emphasis.

```php
echo Parsedown::instance()
   ->setMarkupEscaped(true) # escapes markup (HTML)
   ->text("<div><strong>*Some text*</strong></div>");

# Output:
# <p>&lt;div&gt;&lt;strong&gt;<em>Some text</em>&lt;/strong&gt;&lt;/div&gt;</p>
```

--------------------------------

### Markdown Syntax Inside Code Block

Source: https://github.com/erusev/parsedown/blob/master/test/data/code_block.html

Contains Markdown syntax (blockquote, list, reference) that should be rendered as plain text within a code block, testing that Parsedown does not interpret Markdown inside code blocks.

```markdown
> not a quote
- not a list item
[not a reference]: http://foo.com

```

--------------------------------

### Disable Header Elements in Parsedown Extension

Source: https://github.com/erusev/parsedown/wiki/Writing-Extensions

Overrides blockHeader and blockSetextHeader to return null, disabling both Atx and Setext headers. To disable all headers, also set MarkupEscaped to true to disable HTML support.

```php
class Extension extends Parsedown
{
    protected function blockHeader($Line)
    {
        return;
    }

    protected function blockSetextHeader($Line)
    {
        return;
    }
}
```

--------------------------------

### Parse inline elements with line()

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Get-Started

Uses the line() method to parse only inline elements, not block-level elements. The output is inline HTML without paragraph tags.

```php
echo Parsedown::instance()->line('Hello _Parsedown_!'); 

# Output:
# Hello <em>Parsedown</em>!
```

--------------------------------

### PHP fenced code block with language identifier

Source: https://github.com/erusev/parsedown/blob/master/test/data/fenced_code_block.md

A fenced code block with a 'php' language identifier. The code echoes a string.

```php
echo 'language identifier';

```

--------------------------------

### PHP fenced code block with class attribute

Source: https://github.com/erusev/parsedown/blob/master/test/data/fenced_code_block.md

A fenced code block with a language identifier and an additional class attribute (php some-class). The code echoes a string.

```php
<?php
echo "Hello World";

```

--------------------------------

### Incomplete fence closing

Source: https://github.com/erusev/parsedown/blob/master/test/data/fenced_code_block.html

A fenced block that is not closed correctly, showing incomplete fence behavior.

```markup
the following isn't quite enough to close

```

--------------------------------

### PHP fenced code block with backticks

Source: https://github.com/erusev/parsedown/blob/master/test/data/fenced_code_block.md

A basic fenced code block using triple backticks with PHP code. The code assigns a message and echoes it.

```php
<?php

$message = 'fenced code block';
echo $message;

```

--------------------------------

### Add ColoredText Inline Element in Parsedown Extension

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Create-Extensions

Adds a custom inline element for colored text by registering a new inline type in the constructor and defining the inlineColoredText method. The method uses a regex to match the pattern {c:color}text{/c} and returns an element with a span and style attribute. The extent is set to the length of the matched string.

```php
class Extension extends Parsedown
{

    function __construct()
    {
        $this->InlineTypes['{'][]= 'ColoredText';

        $this->inlineMarkerList .= '{';
    }

    protected function inlineColoredText($excerpt)
    {
        if (preg_match('/^{c:([#\w]\w+)}(.*?){\/c}/', $excerpt['text'], $matches))
        {
            return array(

                // How many characters to advance the Parsedown's
                // cursor after being done processing this tag.
                'extent' => strlen($matches[0]), 
                'element' => array(
                    'name' => 'span',
                    'text' => $matches[2],
                    'attributes' => array(
                        'style' => 'color: ' . $matches[1],
                    ),
                ),

            );
        }
    }

}
```

--------------------------------

### Whitespace Preservation in Code Block

Source: https://github.com/erusev/parsedown/blob/master/test/data/code_block.html

A code block with multiple blank lines to test that Parsedown preserves whitespace and line breaks exactly as written.

```text
foo


bar

```

--------------------------------

### Escape HTML in trusted input with setMarkupEscaped

Source: https://github.com/erusev/parsedown/blob/master/readme.md

Use setMarkupEscaped(true) to escape HTML in trusted input. Warning: this method is not safe from XSS, as it still allows unsafe scripting vectors like '[xss](javascript:alert%281%29)'.

```php
$Parsedown->setMarkupEscaped(true);
```

--------------------------------

### Prevent automatic URL linking with setUrlsLinked

Source: https://github.com/erusev/parsedown/wiki/Tutorial:-Get-Started

Sets the setUrlsLinked option to false to disable automatic linking of URLs. The output shows the URL as plain text.

```php
echo Parsedown::instance()
   ->setUrlsLinked(false) # prevents automatic linking of URLs
   ->text("You can find Parsedown at http://parsedown.org");

# Output:
# <p>You can find Parsedown at http://parsedown.org</p>
```

--------------------------------

### Tilde fenced code block

Source: https://github.com/erusev/parsedown/blob/master/test/data/fenced_code_block.md

A fenced code block using triple tildes. The content is plain text without a language identifier.

```text
tilde

```

--------------------------------

### Markdown non-code block

Source: https://github.com/erusev/parsedown/blob/master/test/data/code_block.md

A block of text that is not a quote, list item, or reference. It demonstrates that indented text is treated as a code block, not as Markdown formatting.

```markdown
> not a quote
- not a list item
[not a reference]: http://foo.com
```

--------------------------------

### HTML+PHP fenced code block

Source: https://github.com/erusev/parsedown/blob/master/test/data/fenced_code_block.md

A fenced code block with a combined language identifier 'html+php'. Contains PHP code and an HTML anchor tag.

```html+php
<?php
echo "Hello World";
?>
<a href="http://auraphp.com" >Aura Project</a>

```

--------------------------------

### Nested fenced code block with inner backticks

Source: https://github.com/erusev/parsedown/blob/master/test/data/fenced_code_block.md

A fenced code block using four backticks that contains a triple backtick fence inside. The inner fence does not close the outer block.

```text
the following isn't quite enough to close
```
still a fenced code block

```

--------------------------------

### C# fenced code block with non-word language identifier

Source: https://github.com/erusev/parsedown/blob/master/test/data/fenced_code_block.md

A fenced code block with a language identifier containing non-word characters (c#). The code echoes a string.

```c#
echo 'language identifier with non words';

```

--------------------------------

### Add Custom Inline Element for Colored Text

Source: https://github.com/erusev/parsedown/wiki/Writing-Extensions

Adds a custom inline element 'ColoredText' by registering '{' in InlineTypes and inlineMarkerList. The inlineColoredText method parses a pattern like {c:color}text{/c} and returns a span element with a style attribute.

```php
class Extension extends Parsedown
{
    function __construct()
    {
        $this->InlineTypes['{'] []= 'ColoredText';

        $this->inlineMarkerList .= '{';
    }

    protected function inlineColoredText($Excerpt)
    {
        if (preg_match('/^{c:([#\w]\w+)}([^{]+){\/c}/', $Excerpt['text'], $matches))
        {
            return array(
                'extent' => strlen($matches[0]),
                'element' => array(
                    'name' => 'span',
                    'text' => $matches[2],
                    'attributes' => array(
                        'style' => 'color: '.$matches[1],
                    ),
                ),
            );
        }
    }
}
```
Tokens:
Raw