Download the PHP package czukowski/markdown-toc without Composer
On this page you can find all versions of the php package czukowski/markdown-toc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download czukowski/markdown-toc
More information about czukowski/markdown-toc
Files in czukowski/markdown-toc
Package markdown-toc
Short Description Table of Contents generator for cebe/markdown
License MIT
Homepage https://github.com/czukowski/markdown-toc
Informations about the package markdown-toc
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!
Installation
Recommended installation is via composer by running:
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:
Usage
This package provides a TOCTrait
that may be used in classes extending the cebe's original Markdown
parsers.
For more information on how to extend the parser, refer to the original Readme file.
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:
In the examples above, it's assumed that you've created a class named MyMarkdownWithTOC
that uses
TOCTrait
.
Additional optional arguments are available that define the list type used and limit the headline levels that ToC is generated from.
Reference
-
generateTableOfContents($markdown, $url, $listType = 'ul', $fromLevel = 1, $toLevel = 6)
:- @param string
$markdown
markdown source. - @param string
$url
source URL. - @param string
$listType
supported values:ul
andol
. - @param integer
$fromLevel
use headlines starting with this level - @param integer
$toLevel
use headlines up to this level - @return string
- @param string
generateTableOfContentsFromMultiple($sources, $listType = 'ul', $fromLevel = 1, $toLevel = 6)
:- @param array
$sources
markdown sources and URLs. - @param string
$listType
supported values:ul
andol
. - @param integer
$fromLevel
use headlines starting with this level - @param integer
$toLevel
use headlines up to this level - @return string
- @param array
License
The distribution is permitted under the MIT License. See LICENSE.md for details.