Table of Contents generator for cebe/markdown

This package provides a PHP trait that to use with cebe's Markdown implementation. It allows to generate ToC from headlines in Makrdown documents and render them as lists. Note: the output is a rendered HTML, not Markdown!, _(*1)

Installation

Recommended installation is via composer by running:, _(*2)

composer require czukowski/markdown-toc "~1.0"

Alternatively you may add the following to the require section of your project's composer.json manually and then run composer update from the command line:, _(*3)

"czukowski/markdown-toc": "~1.0"

Usage

This package provides a TOCTrait that may be used in classes extending the cebe's original Markdown parsers., _(*4)

For more information on how to extend the parser, refer to the original Readme file., _(*5)

Generating Table of Contents can then be done by calling either of the two available public methods, depending on whether you are generating ToC from one or multiple files:, _(*6)

$markdown = new MyMarkdownWithTOC;

// Generate ToC from a single file:
$toc1 = $markdown->generateTableOfContents($source, 'index.md');

// Generate ToC from multiple files:
$toc2 = $markdown->generateTableOfContentsFromMultiple([
    [$intro, 'intro.md'],
    [$issues, 'issues.md'],
    [$reference, 'reference.md'],
]);

In the examples above, it's assumed that you've created a class named MyMarkdownWithTOC that uses TOCTrait., _(*7)

Additional optional arguments are available that define the list type used and limit the headline levels that ToC is generated from., _(*8)

Reference

generateTableOfContents($markdown, $url, $listType = 'ul', $fromLevel = 1, $toLevel = 6):, _(*9)
- @param string $markdown markdown source.
- @param string $url source URL.
- @param string $listType supported values: ul and ol.
- @param integer $fromLevel use headlines starting with this level
- @param integer $toLevel use headlines up to this level
- @return string
generateTableOfContentsFromMultiple($sources, $listType = 'ul', $fromLevel = 1, $toLevel = 6):, _(*10)
- @param array $sources markdown sources and URLs.
- @param string $listType supported values: ul and ol.
- @param integer $fromLevel use headlines starting with this level
- @param integer $toLevel use headlines up to this level
- @return string