jampire/toc-markdown-extra

Adds Table of Contents capability to PHP Markdown Extra package

v1.0.1 2020-01-24 12:36 UTC

Requires

• php: >=5.3.0
• michelf/php-markdown: ^1.9

Requires (Dev)

• jakub-onderka/php-console-highlighter: ^0.4.0
• jakub-onderka/php-parallel-lint: ^1.0
• phpunit/phpunit: ^5.7|^6.0|^8.4
• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: ^2.3|^3.5

MIT

• Dzianis Kotau
• Dragonfly Development Inc.
• Beau Simensen

• markdown
• extra
• TOC
• table of contents
• PHP Markdown Extra

README

This package adds Table of Contents capability (TOC) to PHP Markdown package.

TOC functionality is ported from Sculpin project. Sculpin is Static Site Generator written in PHP and based on Symfony.

Installation

To install, use composer:

composer require jampire/toc-markdown-extra

Usage

Please, see my article and PHP Markdown documentation.

You can use PhpStorm IDE with Markdown (bundled) plugin to automatically generate TOC as PhpStorm uses the same algorithm for id generation.

License

The MIT License (MIT). Please see License File for more information.