Download the PHP package jifish/parsedown-toc-ext without Composer

On this page you can find all versions of the php package jifish/parsedown-toc-ext. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package parsedown-toc-ext

Parsedown TOC Extension

A simple, lightweight, and modern Table of Contents extension for Parsedown and ParsedownExtra. MIT licenced.

Provides:

This extension works with both original parsedown and the community fork of Parsedown.

Inspired by Benjamin Hoegh's ParsedownToc.

Installation

If you want Parsedown Extra support:

If you want the community fork of Parsedown, install it first.

Basic Usage

Parsedown

Parsedown Extra

Substitution of [TOC] marker

Custom id generation

If you need you own id generation strategy, you can override slugify:

Heading ID Generation

Heading IDs are:

Example:

Becomes:

Interfaces

Basic Usage

text(string $markdown): string

As with Parsedown, but adds heading IDs, and builds and stores a new TOC structure.

getToc(): array

Returns the internal TOC structure.

Format:

getTocCount(): int

Returns the number of headings in the TOC.

removeHeading(string $id): void

Removes a heading from the TOC by its ID.

renderToc(...)

Generates a Markdown-formatted TOC.

Parameters:

hasToc(): bool

Returns whether the internal TOC currently contains any entries.

Customising TOC

appendHeading(int $level, string $text, ?string $id = null): string

Manually adds an entry to the end of the internal TOC structure, and returns its id.

This allows you to add headings that are not present in the Markdown source, for use when combining parsed headings with dynamic or generated content, or to generate TOCs without any source markdown.

Note: Calling text() will clear the internal TOC.

Parameters

Example:

Output:

prependHeading(int $level, string $text, ?string $id = null): string

As above, but adds the heading to the top instead.

insertHeadingAfter(string $afterId, int $level, string $text, ?string $id = null): string

As above, but inserts the heading directly below $afterId. Throws a ValueError if the id is not found.


All versions of parsedown-toc-ext with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
erusev/parsedown Version ^1.8
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jifish/parsedown-toc-ext contains the following files

Loading the files please wait ...