Download the PHP package cable8mm/toc without Composer

On this page you can find all versions of the php package cable8mm/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?

Example code of cable8mm/toc

Informations about the package toc

TOC - Table of Contents Parser for Markdown

code-style run-tests Packagist Version Packagist Downloads Packagist Dependency Version Packagist Stars Packagist License

TOC parses Markdown documents and extracts table of contents (navigation) structures. It supports multiple documentation formats including Laravel, Samsung Tizen, Naver Clova AI, and Rhymix.

Originally built for the document2 project.

Installation

Quick Start

Parse a Markdown TOC and iterate over its items:

Supported Document Styles

Laravel Style (- ## Section, indented - [Page](link))

Samsung Tizen Style (# Section, ## [Page](link))

Naver Clova AI Style (# Section, * [Page](link) with 2-space indent)

Rhymix Style (### Section, - [Page](link))

API Reference

Toc — Main parser class

Method Description Returns
Toc::of(string $markdown) Create and parse markdown in one call (factory) Toc
new Toc(string $markdown) Create instance (call ->of() to parse) Toc
getLines() Get all parsed line items Item[]
getLine(int $n) Get the nth line item (0-based) Item
getSectionTitle(string $pageTitle) Find the section title containing a page ?string
toArray() Get grouped sections with their pages array
addConverters(ConverterInterface[]) Add custom preprocessors static

Example — find which section a page belongs to:

Example — grouped navigation structure:

Item — A single TOC line

Method Description Returns
getTitle() Extract the display title string
getLink() Extract the URL (if it's a link) ?string
getType() Whether it's a section or page ItemEnum
getDepth() Nesting level (1-based) int
toHtml() Render as <li> HTML tag string

Example — render as HTML:

ItemEnum — Item type enum

Case Meaning
ItemEnum::section A section heading (no link)
ItemEnum::page A page entry (has a link)

Advanced Usage

Custom depth calculation

Different documentation styles use different indent patterns. Pass style-specific parameters to getDepth():

Custom converters

Add preprocessors to clean or transform markdown before parsing:

You can also implement your own converter by implementing ConverterInterface:

Testing

Code Style

License

The MIT License (MIT). See LICENSE.

All versions of toc with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
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 cable8mm/toc contains the following files

Loading the files please wait ...