https://github.com/imarc/entry-toc
Adds a Table of Contents to long Neo and Matrix entry types
https://github.com/imarc/entry-toc
Last synced: 6 months ago
JSON representation
Adds a Table of Contents to long Neo and Matrix entry types
- Host: GitHub
- URL: https://github.com/imarc/entry-toc
- Owner: imarc
- License: mit
- Created: 2023-07-19T13:39:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-03T16:00:14.000Z (about 1 year ago)
- Last Synced: 2025-09-14T12:56:02.561Z (10 months ago)
- Language: Twig
- Size: 22.5 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Entry Table of Contents
Adds a Table of Contents to in the CMS to entry editing screens with long matrix or neo blocks to make it easier to jump down the page to the block you want to edit.
## Requirements
This plugin requires Craft CMS 4.4.0 or later, and PHP 8.0.2 or later.
Alternatively, this plugin requires Craft CMS 5.0 or later, and PHP 8.2 or later.
## Installation
You can install this plugin from the Plugin Store or with Composer.
#### From the Plugin Store
Go to the Plugin Store in your project’s Control Panel and search for “Entry TOC”. Then press “Install”.
#### With Composer
Open your terminal and run the following commands:
```bash
# go to the project directory
cd /path/to/my-project.test
# tell Composer to load the plugin
composer require imarc/craft-entry-toc
# tell Craft to install the plugin
./craft plugin/install entry-toc
```
## Configuration
To select which matrix or neo blocks show a table of contents, copy the **entry-toc.php** file into your `config` directory. Replace the example fields like `exampleNeoField` with the name of the field you want to create a table of contents for. Replace the `exampleHeading` and similar with the name of the field within the matrix or neo block that contains the block's headline.
If that fields is empty, the table of contents will just show the block type. If it is populated, it will show **Block Type - Your Headline Here**.