Skip to content

Commit 58cf86d

Browse files
docs: document stripTags option (#71)
1 parent b9e2768 commit 58cf86d

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ composer require overtrue/laravel-versionable -vvv
3333
First, publish the config file and migrations:
3434

3535
```bash
36-
php artisan vendor:publish --provider="Overtrue\LaravelVersionable\ServiceProvider"
36+
php artisan vendor:publish --provider="Overtrue\LaravelVersionable\ServiceProvider"
3737
```
3838

3939
Then run this command to create a database migration:
@@ -195,20 +195,21 @@ $diff->toArray();
195195
### Other formats
196196

197197
```php
198-
toArray(array $differOptions = [], array $renderOptions = []): array
199-
toText(array $differOptions = [], array $renderOptions = []): array
200-
toJsonText(array $differOptions = [], array $renderOptions = []): array
201-
toContextText(array $differOptions = [], array $renderOptions = []): array
202-
toHtml(array $differOptions = [], array $renderOptions = []): array
203-
toInlineHtml(array $differOptions = [], array $renderOptions = []): array
204-
toJsonHtml(array $differOptions = [], array $renderOptions = []): array
205-
toSideBySideHtml(array $differOptions = [], array $renderOptions = []): array
198+
toArray(array $differOptions = [], array $renderOptions = [], bool $stripTags = false): array
199+
toText(array $differOptions = [], array $renderOptions = [], bool $stripTags = false): array
200+
toJsonText(array $differOptions = [], array $renderOptions = [], bool $stripTags = false): array
201+
toContextText(array $differOptions = [], array $renderOptions = [], bool $stripTags = false): array
202+
toHtml(array $differOptions = [], array $renderOptions = [], bool $stripTags = false): array
203+
toInlineHtml(array $differOptions = [], array $renderOptions = [], bool $stripTags = false): array
204+
toJsonHtml(array $differOptions = [], array $renderOptions = [], bool $stripTags = false): array
205+
toSideBySideHtml(array $differOptions = [], array $renderOptions = [], bool $stripTags = false): array
206206
```
207207

208208
> **Note**
209209
>
210210
> `$differOptions` and `$renderOptions` are optional, you can set them following the README
211211
> of [jfcherng/php-diff](https://github.com/jfcherng/php-diff#example).
212+
> `$stripTags` allows you to remove HTML tags from the Diff, helpful when you don't want to show tags.
212213
213214
### Using custom version model
214215

0 commit comments

Comments
 (0)