https://github.com/ntd/silverstripe-autotoc

Dynamically generates the table of contents
https://github.com/ntd/silverstripe-autotoc

module silverstripe silverstripe-module

Last synced: about 1 year ago
JSON representation

Dynamically generates the table of contents

• Host: GitHub
• URL: https://github.com/ntd/silverstripe-autotoc
• Owner: ntd
• License: bsd-2-clause
• Created: 2013-08-24T16:39:04.000Z (almost 13 years ago)
• Default Branch: dev
• Last Pushed: 2017-12-30T11:38:51.000Z (over 8 years ago)
• Last Synced: 2025-03-22T09:02:18.846Z (over 1 year ago)
• Topics: module, silverstripe, silverstripe-module
• Language: PHP
• Homepage:
• Size: 94.7 KB
• Stars: 7
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
silverstripe-autotoc

====================

[![License](https://poser.pugx.org/entidi/silverstripe-autotoc/license)](https://packagist.org/packages/entidi/silverstripe-autotoc)

[![Build Status](https://travis-ci.org/ntd/silverstripe-autotoc.svg?branch=master)](https://travis-ci.org/ntd/silverstripe-autotoc)

[![Code Quality](https://scrutinizer-ci.com/g/ntd/silverstripe-autotoc/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/ntd/silverstripe-autotoc/?branch=master)

[![Code Coverage](https://scrutinizer-ci.com/g/ntd/silverstripe-autotoc/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/ntd/silverstripe-autotoc/?branch=master)

[![Latest Stable Version](https://poser.pugx.org/entidi/silverstripe-autotoc/v/stable)](https://packagist.org/packages/entidi/silverstripe-autotoc)

Automatically generate the table of contents from the *Content* of a

page or, more generally, from any HTML field.

This module can be used without the CMS.

Installation

------------

    composer require entidi/silverstripe-autotoc

Manual installation is probably possible but not really tested.

Testing

-------

Basically it boils down to the following commands:

    composer update

    vendor/bin/phpunit

Other documentation

-------------------

* [Usage](docs/en/usage.md)

* [Autotoc format](docs/en/format.md)

* [Contributing](CONTRIBUTING.md)

* [Code of Conduct](https://docs.silverstripe.org/en/contributing/code_of_conduct)

* [BSD license](LICENSE.md)

* [ChangeLog](CHANGELOG.md)

* [Support](docs/en/support.md)