silverstripe-autotoc 

silverstripe-autotoc Git Source Tree

Root/README.md

1silverstripe-autotoc
2====================
3[![License](https://poser.pugx.org/entidi/silverstripe-autotoc/license)](https://packagist.org/packages/entidi/silverstripe-autotoc)
4[![Build Status](https://travis-ci.org/ntd/silverstripe-autotoc.svg?branch=master)](https://travis-ci.org/ntd/silverstripe-autotoc)
5[![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)
6[![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)
7[![Latest Stable Version](https://poser.pugx.org/entidi/silverstripe-autotoc/v/stable)](https://packagist.org/packages/entidi/silverstripe-autotoc)
8
9Automatically generate the table of contents from the *Content* of a
10page or, more generally, from any HTML field.
11
12This module can be used without the CMS.
13
14Installation
15------------
16
17 composer require entidi/silverstripe-autotoc
18
19Manual installation is probably possible but not really tested.
20
21Testing
22-------
23
24Basically it boils down to the following commands:
25
26 composer update
27 vendor/bin/phpunit
28
29Other documentation
30-------------------
31
32* [Usage](docs/en/usage.md)
33* [Autotoc format](docs/en/format.md)
34* [Contributing](CONTRIBUTING.md)
35* [Code of Conduct](https://docs.silverstripe.org/en/contributing/code_of_conduct)
36* [BSD license](LICENSE.md)
37* [ChangeLog](CHANGELOG.md)
38* [Support](docs/en/support.md)

Archive Download this file