keinos/parsedown-toc

Table of Contents Extension for Parsedown, the Parser for Markdown.

Maintainers

Details

github.com/KEINOS/parsedown-extension_table-of-contents

Homepage

Source

Issues

Installs: 15 407

Dependents: 2

Suggesters: 0

Security: 0

Stars: 13

Watchers: 4

Forks: 5

Open Issues: 9

Language:Shell

v1.2.0 2023-02-19 00:56 UTC

Requires

MIT fb27265990ceafaceba9b157b25389fc6124badc

parsermarkdownextension

This package is auto-updated.

Last update: 2024-11-19 04:37:53 UTC

README

Parsedown ToC Extension

Listing Table of Contents Extension for Parsedown.

This simple PHP file extends Parsedown Vanilla / Parsedown Extra to generate a list of header index (a.k.a. Table of Contents or ToC), from a markdown text given.

composer require keinos/parsedown-toc
$ cat ./parse_sample.php
<?php
require_once __DIR__ . '/vendor/autoload.php';

// Sample Markdown with '[toc]' tag included
$text_markdown = file_get_contents('SAMPLE.md');

$Parsedown = new \ParsedownToC();

// Parses '[toc]' tag to ToC if exists
$html = $Parsedown->text($text_markdown);

echo $html . PHP_EOL;
$ cat ./SAMPLE.md
[toc]

---

# One
Something about One

## Two
Something about Two

# One2
Something about One2
$ php ./parse_sample.php
<div id="toc"><ul>
<li><a href="#One">One</a><ul>
<li><a href="#Two">Two</a></li>
</ul>
</li>
<li><a href="#One2">One2</a></li>
</ul></div>
<hr />
<h1 id="One" name="One">One</h1>
<p>Something about One</p>
<h2 id="Two" name="Two">Two</h2>
<p>Something about Two</p>
<h1 id="One2" name="One2">One2</h1>
<p>Something about One2</p>

With the toc() method, you can get just the "ToC".

<?php
// Parse body and ToC separately

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

$text_markdown = file_get_contents('SAMPLE.md');
$Parsedown     = new \ParsedownToC();

$body = $Parsedown->body($text_markdown);
$toc  = $Parsedown->toc();

echo $toc . PHP_EOL;  // Table of Contents in <ul> list
echo $body . PHP_EOL; // Main body
  • Main Class: ParsedownToC()
    • Arguments: none
    • Methods:
      • text(string $text):
        • Returns the parsed content and [toc] tag(s) parsed as well.
        • Required argument $text: Markdown string to be parsed.
      • body(string $text):
        • Returns the parsed content WITHOUT parsing [toc] tag.
        • Required argument $text: Markdown string to be parsed.
      • toc([string $type_return='string']):
        • Returns the ToC, the table of contents, in HTML or JSON.
        • Option argument:
          • $type_return:
            • string or json can be specified. string=HTML, json=JSON.
            • Default string
        • Alias method: contentsList(string $type_return)
      • setTagToc(string $tag='[tag]'):
        • Sets user defined ToC markdown tag. Use this method before text() or body() method if you want to use the ToC tag rather than the "[toc]".
        • Empty value sets the default ToC tag.
        • Available since v1.1.2
    • Other Methods:
      • All the public methods of Parsedown and/or Parsedown Extend are available to use.
    • Note: As of v1.1.0 the old alias class: Extension() is deprecated.

Online Demo

Install

Via Composer

If you are familiar to composer, the package manager for PHP, then install it as below:

# Current stable
composer require keinos/parsedown-toc

# Latest
composer require keinos/parsedown-toc:dev-master

Manual Install (Download the script)

You can download the 'Extension.php' file from the below URL. Place it anywhere you like to include.

https://KEINOS.github.io/parsedown-extension_table-of-contents/Extension.php
# Download via cURL
curl -O https://KEINOS.github.io/parsedown-extension_table-of-contents/Extension.php
# Download via PHP
php -r "copy('https://KEINOS.github.io/parsedown-extension_table-of-contents/Extension.php', './Extension.php');"

Sample Usage

Advanced Usage (Using Parsedown Extra)

As of Parsedown ToC Extension v1.1.1, you can use the anchor identifiers for Parsedown Extra.

With this feature, you can specify the anchor name you like. Useful if the headings are in UTF-8 (not in ASCII) and to make it readable. Such as placing the "go back" links in a page.

# SampleHead1 {#self-defined-head1}
Sample text of head 1

---

[Link back to header 1](#self-defined-head1)

With the above markdown the generated ToC will be as below. Note that the anchor is changed to the specified one.

<ul>
<li><a href="#self-defined-head1">SampleHead1</a></li>
</ul>
  • Note that you need to require/include the Parsedown Extra as well.

References