Download the PHP package keinos/parsedown-toc without Composer

On this page you can find all versions of the php package keinos/parsedown-toc. 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

Unit Tests Supported PHP Version Badge Parsedown Version Badge PHPDoc Badge

Parsedown ToC Extension

Listing Table of Contents Extension for Parsedown.

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

Basic Usage

Parsedown Vanilla
Parsedown Extra

Installation

This extension, ParsedownToC, is a single PHP file. Download and place it in the same directory as the Parsedown.php file (optionally place the ParsedownExtra.php file if you are using it).

Manual Install You can download the latest '[Extension.php](https://github.com/KEINOS/parsedown-extension_table-of-contents/blob/master/Extension.php)' file from the below URL. Place it anywhere you like to include. > Since this is an extension of [Parsedown](https://parsedown.org/), you need to download and include `Parsedown.php` as well.

Via Composer

We also support Composer for installation and convenience.

Basic Usage Using Composer
To use the extension via Composer, include the autoloader (`vendor/autoload.php` file) instead of the `Parsedown.php` and `Extension.php` file.

Requirements

PardesownToC itself supports PHP 5.5 up-to current latest PHP 8.4.

However, the latest stable release of Parsedown 1.7.4 do not fully support PHP 8.4. And ParsedownExtra 0.8.1 do not fully support PHP 7.1 or later. Which throws deprecation warnings of PHP.

Stable Combination

To use both the stable released versions of Parsedown 1.7.4 and ParsedownExtra 0.8.1, you need to use between PHP 5.5 and PHP 7.0.

With later PHP versions you will get several deprecation warnings.

Script Name Versions
PHP Static Badge
Parsedown.php Parsedown Version Badge
SHA256 Hash: af4a4b29f38b5a00b003a3b7a752282274c969e42dee88e55a427b2b61a2f38f
ParsedownExtra.php ParsedownExtra Version Badge
SHA256 Hash: b0c6bd5280fc7dc1caab4f4409efcae9fb493823826f7999c27b859152494be7

Last-gasp Effort Combination

For PHP 8.4 or higher users: We have patched versions of Parsedown 1.7.4 and ParsedownExtra 0.8.1 to support PHP 8.4, the current latest PHP version and above.

These patched versions do not have any new features or refactoring made. Only the deprecation warnings from PHP are removed.

Use these combinations if you want to use the exact same features as the stable version with the latest PHP version.

Script Name Versions
PHP Parsedown Version Badge
Parsedown.php (patched)
SHA256 Hash: b81a67cdd55e984bacc5fa5be84a15794de94b71841a18a9028a13ab9a41756a
(no new feature and refactoring)
ParsedownExtra.php (patched)
SHA256 Hash: 2873b8eac69aae9d8422dba1efc53c143ab85b570bfe8429035eeb47014cb5ca
(no new feature and refactoring)

[!NOTE] We are not supporting Parsedown v2 or above until the official beta release.

Class Info and Methods

For more details, please refer to the PHP Doc reference.

Online Demo

Advanced Usage (Using Parsedown Extra)

As of ParsedownToC 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.

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

Testing

Eventhough we are migraing the tests to PHPUnit, currently we use hand-made test scripts to run the unit tests via bash.

Testing using docker (docker compose)

Testing locally

To run the tests:

[!IMPORTANT] This test will download/install dependencies such as: Parsedown.php, ParsedownExtra.php, git, jq, curl and bash if not installed. So please run this test in a safe Unix-like environment (docker for example).

References


All versions of parsedown-toc with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5.0 <=8.4
ext-mbstring Version *
erusev/parsedown Version 1.7.4
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 keinos/parsedown-toc contains the following files

Loading the files please wait ....