README

This is a PHP package that generates Table of Contents from HTML.

Installation

You can install the package via composer:

composer require l3aro/html-toc

Usage

With Dependency Injection

use l3aro\HtmlToc\HtmlToc;

public function show(HtmlToc $toc) {
    $content = <<<HTML
        <h2>This is heading H2</h2>
        <h3>This is heading H3</h3>
        <h4>This is heading H4</h4>
        <h2>This is heading H2</h2>
    HTML;

    $markup = $toc->from($content);
    $markupContent = $markup->getMarkup();
    $tableOfContent = $markup->getTableOfContent();

    $htmlOut  = "<div class='content'>" . $markupContent . "</div>";
    $htmlOut .= "<div class='toc'>" . $tableOfContent . "</div>";

    return $htmlOut;
 }

With Facade

use l3aro\HtmlToc\Facades\HtmlToc;

public function show() {
    $content = <<<HTML
        <h2>This is heading H2</h2>
        <h3>This is heading H3</h3>
        <h4>This is heading H4</h4>
        <h2>This is heading H2</h2>
    HTML;

    $markup = HtmlToc::from($content);
    $markupContent = $markup->getMarkup();
    $tableOfContent = $markup->getTableOfContent();

    $htmlOut  = "<div class='content'>" . $markupContent . "</div>";
    $htmlOut .= "<div class='toc'>" . $tableOfContent . "</div>";

    return $htmlOut;
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

l3aro / html-toc

Maintainers

Details