Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fxcjahid committed Feb 25, 2023
1 parent db10a17 commit 3d758ad
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@ Laravel Table of Content Generator

Generates a Table of Contents from ***H1...H6*** Tags in HTML Content

[Latest Version on Packagist][link-packagist]

[Github Build][link-ghbuild]

[PHPStan Level 8][link-phpstan]
[Total Downloads][link-downloads]


This package provides a simple library to build a Table-of-Contents from HTML markup. It does so by evaluating your *H1...H6* tags.
It can also automatically add appropriate *id* anchor attributes to header tags so that in-page links work.
Expand All @@ -29,15 +22,15 @@ Installation Options

Install with composer :

`composer require caseyamcl/toc ~2.0.0`
` composer require fxcjahid/laravel-table-of-content `

Usage
-----

This package contains two main classes:

1. ` fxcjahid\LaravelTableOfContent\MarkupFixer`: Adds `id` anchor attributes to any *H1*...*H6* tags that do not already have any (you can specify which header tag levels to use at runtime)
2. ` fxcjahid\LaravelTableOfContent\Table ` : Generates a Table of Contents from HTML markup
2. `fxcjahid\LaravelTableOfContent\Table ` : Generates a Table of Contents from HTML markup

Basic Example:

Expand Down Expand Up @@ -127,6 +120,4 @@ use Fxcjahid\LaravelTableOfContent\MarkupFixer;
}
```



* This package inspired by https://github.com/caseyamcl/toc

0 comments on commit 3d758ad

Please sign in to comment.