Download the PHP package benjaminhoegh/parsedown-toc without Composer
On this page you can find all versions of the php package benjaminhoegh/parsedown-toc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download benjaminhoegh/parsedown-toc
More information about benjaminhoegh/parsedown-toc
Files in benjaminhoegh/parsedown-toc
Download benjaminhoegh/parsedown-toc
More information about benjaminhoegh/parsedown-toc
Files in benjaminhoegh/parsedown-toc
Vendor benjaminhoegh
Package parsedown-toc
Short Description Table of Contents Extension for Parsedown.
License MIT
Homepage https://github.com/BenjaminHoegh/parsedownToc/
Package parsedown-toc
Short Description Table of Contents Extension for Parsedown.
License MIT
Homepage https://github.com/BenjaminHoegh/parsedownToc/
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:
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.
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
ParsedownToc
ParsedownToc is an extension for Parsedown and ParsedownExtra that introduces advanced features for developers working with Markdown. It is based on @KEINOS toc extention
Features:
- Speed: Super-fast processing.
- Configurability: Easily customizable for different use-cases.
- Custom Header IDs: Full support for custom header ids.
Prerequisites:
- Requires Parsedown 1.7.4 or later.
Installation:
Ensure you have Composer installed on your system.
-
Install the ParsedownToc package using Composer:
- Alternatively, you can download the latest release and include
Parsedown.phpin your project.
Usage:
Basic example:
Separate body and ToC:
Configuration:
The ParsedownToc->setOptions(array $options) method allows you to configure the main class. Below are the available options along with their default values and descriptions:
| Option | Type | Default | Description |
|---|---|---|---|
| selectors | array | ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'] | HTML heading tags to include in the ToC. |
| delimiter | string | - |
Character used between words and duplicate suffixes. |
| max_anchor_length | int | null |
Maximum character length for generated anchor IDs. |
| lowercase | boolean | true |
Convert anchor IDs to lowercase. |
| replacements | array | none | Custom regex replacements applied before sanitization. |
| transliterate | boolean | true |
Transliterate non-ASCII characters to ASCII equivalents. |
| urlencode | boolean | false |
Uses PHP built-in urlencode and disables all other options. |
| reserved_ids | array | [] |
Anchor IDs that must not be generated; duplicates are suffixed instead. |
| base_url | string | `` | Prefixes each ToC anchor link with the specified URL. |
| anchor_prefix | string | `` | Static string prepended to every generated anchor ID. |
| toc_tag | string | [toc] |
Markdown tag that is replaced with the rendered ToC. |
| toc_id | string | toc |
id attribute of the wrapping <div> around the ToC. |
Methods:
The ParsedownToc class offers several methods for different functionalities:
- text(string $text): Returns the parsed content and
[toc]tag(s). - body(string $text): Returns the parsed content without the
[toc]tag. - contentsList([string $type_return='html']): Returns the ToC in HTML, JSON, or as an array.
- Optional: Specify the return type as
html,json, orarray.
- Optional: Specify the return type as
- setTocSelectors(array $selectors): Set which heading levels to include in the ToC.
- setTocDelimiter(string $delimiter): Define a custom delimiter.
- setTocMaxAnchorLength(?int $length): Set the maximum character length for generated anchor IDs.
- setTocLowercase(bool $boolean): Choose whether anchor IDs should be lowercased.
- setTocReplacements(?array $replacements): Provide custom regex replacements applied before sanitization.
- setTocTransliterate(bool $boolean): Specify if transliterations should be made.
- setTocUrlencode(bool $boolean): Decide if you want to use PHP's built-in
urlencode. - setTocReservedIds(array $reservedIds): Define anchor IDs that must not be generated; duplicates are suffixed instead.
- setTocBaseUrl(string $url): Set a URL prefix for all ToC anchor links.
- setTocAnchorPrefix(string $prefix): Prepend a static string to every generated anchor ID.
- setTocTag(string $tag): Set a custom ToC markdown tag.
- setTocId(string $id): Set a custom
idattribute for the ToC wrapper element.
Deprecated methods
The following methods still work but emit an E_USER_DEPRECATED notice. Replace them with the equivalents above.
| Deprecated | Replacement |
|---|---|
setTocLimit(int $limit) |
setTocMaxAnchorLength(?int $length) |
setTocBlacklist(array $blacklist) |
setTocReservedIds(array $reservedIds) |
setTocUrl(string $url) |
setTocBaseUrl(string $url) |
Custom Anchors
If you want to use your own logic for creating slugs for the headings, you can do so by using setCreateAnchorIDCallback.
Example using cocur's slugify:
All versions of parsedown-toc with dependencies
PHP Build Version
Package Version
The package benjaminhoegh/parsedown-toc contains the following files
Loading the files please wait ...