mrgeneral/parsedown-extension

This package is abandoned and no longer maintained. No replacement package was suggested.

A markdown extension for parsedown.

0.1 2018-08-25 11:45 UTC

This package is not auto-updated.

Last update: 2021-09-04 12:52:53 UTC


README

A markdown extension for parsedown , supports [TOC] syntax to generate table of contents.

Installation

Include both Parsedown.php and ParsedownExtension.php or install the composer package.

Example

        $text = <<<EOL
[TOC]
# This is head 1
## This is head 1-1
### This is head 1-3
# Sample text of head 2
## Sample text of head 2-1
EOL;

        $content = ParsedownExtension::instance()
            ->setTocEnabled(true)
            ->text($text);
<ul>
	<li><a href="#This+is+head+1">This is head 1</a>
	<ul>
		<li><a href="#This+is+head+1-1">This is head 1-1</a>
		<ul>
			<li><a href="#This+is+head+1-3">This is head 1-3</a></li>
		</ul>
		</li>
	</ul>
	</li>
	<li><a href="#This+is+head+2">This is head 2</a>
	<ul>
		<li><a href="#This+is+head+2-1">This is head 2-1</a></li>
	</ul>
	</li>
</ul>
<h1 id="This+is+head+1">This is head 1</h1>
<h2 id="This+is+head+1-1">This is head 1-1</h2>
<h3 id="This+is+head+1-3">This is head 1-3</h3>
<h1 id="This+is+head+2">This is head 2</h1>
<h2 id="This+is+head+2-1">This is head 2-1</h2>

Reporting issues

You can create an issue