kunoichi/toc-generator

TOC generator from h1-h6 tags.

1.0.2 2023-08-22 06:00 UTC

Requires

• php: >=7.0
• ext-dom: *
• masterminds/html5: ^2.7

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• phpcompatibility/php-compatibility: ^9.3
• phpunit/phpunit: >5.7
• squizlabs/php_codesniffer: ^3.7
• wp-coding-standards/wpcs: ^2.3
• yoast/phpunit-polyfills: ^2.0

GPL-3.0-or-later

• Kunoichi INC

README

Generate table of contents from h1-h6 tags.

Installation

Run composer.

comopser require kunoichi/toc-generator

And include autoloader.

require __DIR__ . '/vendor/autoload.php';

Usage

PHP

W.I.P

WordPress

In your functions.php

// Register TOC.
// If you have theme option for it,
// detect conditions.
add_action( 'init', function() {
   	$parser = new Kunoichi\TocGenerator\WpParser();
	$parser->set_title( __( 'Table of Contents', 'your-theme' ) );
} );

And render TOC where you want(e.g. In your singular.php). You need $post_id to render TOC. In this case, get_queried_object_id() is used.

Kunoichi\TocGenerator\WpParser::render( get_queried_object_id() );