https://github.com/the-3labs-team/laravel-keyword-linker
🔗 A tool that parse a content and add links to keywords
https://github.com/the-3labs-team/laravel-keyword-linker
Last synced: 6 months ago
JSON representation
🔗 A tool that parse a content and add links to keywords
- Host: GitHub
- URL: https://github.com/the-3labs-team/laravel-keyword-linker
- Owner: The-3Labs-Team
- License: mit
- Created: 2024-07-02T13:53:24.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-02T08:55:28.000Z (8 months ago)
- Last Synced: 2024-11-19T05:04:02.381Z (7 months ago)
- Language: PHP
- Homepage: https://3labs.it
- Size: 41 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Keyword Linker
[](https://packagist.org/packages/the-3labs-team/laravel-keyword-linker)
[](https://github.com/the-3labs-team/laravel-keyword-linker/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/the-3labs-team/laravel-keyword-linker/actions?query=workflow%3Aphpstan+branch%3Amain)
[](https://github.com/the-3labs-team/laravel-keyword-linker/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://codeclimate.com/github/The-3Labs-Team/laravel-keyword-linker/maintainability)
[](https://codeclimate.com/github/The-3Labs-Team/laravel-keyword-linker/test_coverage)
[](https://packagist.org/packages/the-3labs-team/laravel-keyword-linker)
This is a package that converts keywords into links.
## Installation
You can install the package via composer:
```bash
composer install the-3labs-team/keyword-linker
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag=keyword-linker-config
```
This is the contents of the published config file:
```php
return [
'limit-auto-keywords' => 5, // limit auto keywords to be linked
'whitelist' => [
'p',
'blockquote',
],
];
```
## Usage
```php
use The3LabsTeam\KeywordLinker\Facades\KeywordLinker;
$content = "This is a test content";
$keywords = [
'test' => 'https://example.com/test',
// Usage: 'keyword' => 'link'
];
echo KeywordLinker::parse($content, $keywords);
# output: This is a test content
```
### Common usage
Use rel attribute to add nofollow to the link
```php
$keywords = [
'test' => [
'link' => 'https://example.com/test',
'rel' => 'nofollow'
],
// Usage: 'keyword' => ['link' => 'link', 'rel' => 'nofollow']
];
```
Use target attribute to open the link in a new tab
```php
$keywords = [
'test' => [
'link' => 'https://example.com/test',
'target' => '_blank'
],
// Usage: 'keyword' => ['link' => 'link', 'target' => '_blank']
];
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [The-3Labs-Team](https://github.com/the-3labs-team)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.