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[![Latest Stable Version](https://poser.pugx.org/entidi/silverstripe-autotoc/v/stable)](https://packagist.org/packages/entidi/silverstripe-autotoc)
7
8Automatically generate the table of contents from the *Content* of a
9page or, more generally, from any HTML field.
10
11Installation
12------------
13
14If you use [composer](https://getcomposer.org/), you could just run the
15following command:
16
17 composer require entidi/silverstripe-autotoc
18
19To manually install it you should unpack or copy `silverstripe-autotoc`
20into your SilverStripe root directory, rename it to `autotoc` and do a
21`?flush`.
22
23This module can be used without the CMS.
24
25Testing
26-------
27
28Part of this project (the _Tocifier_ class) is intentionally decoupled
29from SilverStripe so it can be tested without pulling in all the
30framework.
31
32From the module root directory you can trigger the testing by calling
33`phpunit` (that must be previously installed on your system):
34
35 phpunit --bootstrap tests/Bootstrap.php tests/
36
37Other documentation
38-------------------
39
40* [Usage](docs/en/usage.md)
41* [AutoTOC format](docs/en/format.md)
42* [Contributing](CONTRIBUTING.md)
43* [BSD license](LICENSE.md)
44* [ChangeLog](CHANGELOG.md)
45* [Support](docs/en/support.md)

Archive Download this file