https://github.com/fuelviews/laravel-robots-txt

Laravel robots.txt package
https://github.com/fuelviews/laravel-robots-txt

fuelviews laravel laravel-robots-txt php robots robots-txt seo txt

Last synced: 2 days ago
JSON representation

Laravel robots.txt package

• Host: GitHub
• URL: https://github.com/fuelviews/laravel-robots-txt
• Owner: fuelviews
• License: mit
• Created: 2024-03-05T17:14:39.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-11-11T22:41:52.000Z (4 days ago)
• Last Synced: 2024-11-11T23:29:44.629Z (4 days ago)
• Topics: fuelviews, laravel, laravel-robots-txt, php, robots, robots-txt, seo, txt
• Language: PHP
• Homepage: https://fuelviews.com
• Size: 75.2 KB
• Stars: 0
• 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 robots txt package

[![Latest Version on Packagist](https://img.shields.io/packagist/v/fuelviews/laravel-robots-txt.svg?style=flat-square)](https://packagist.org/packages/fuelviews/laravel-robots-txt)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/fuelviews/laravel-robots-txt/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/fuelviews/laravel-robots-txt/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/fuelviews/laravel-robots-txt/fix-php-code-style-issues.yml?label=code%20style&style=flat-square)](https://github.com/fuelviews/laravel-robots-txt/actions?query=workflow%3A"Fix+PHP+code+style+issues")

[![Total Downloads](https://img.shields.io/packagist/dt/fuelviews/laravel-robots-txt.svg?style=flat-square)](https://packagist.org/packages/fuelviews/laravel-robots-txt)

Laravel robots txt integrates opinionated default robots.txt

## Installation

You can require the package and it's dependencies via composer:

```bash

composer require fuelviews/laravel-robots-txt

```

You can manually publish the config file with:

```bash

php artisan vendor:publish --provider="Fuelviews\RobotsTxt\RobotsTxtServiceProvider" --tag="robots-txt-config"

```

This is the contents of the published config file:

```php

return [

    /**

     * The disk where the robots.txt file will be saved

     */

    'disk' => 'public',

    /**

     * User agent rules for different paths

     */

    'user_agents' => [

        '*' => [

            'Allow' => [

                '/',

            ],

            'Disallow' => [

                '/admin',

                '/dashboard',

            ],

        ],

    ],

    /**

     * Sitemaps to include in robots.txt

     */

    'sitemap' => [

        'sitemap.xml',

    ],

];

```

## Usage

To access the robots.txt, navigate to your application's URL and append /robots.txt to it.

For example, if your application is hosted at http://example.com, the sitemap can be found at http://example.com/robots.txt.

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](https://github.com/fuelviews/.github/blob/main/CONTRIBUTING.md) for details.

## Security Vulnerabilities

If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.

## Credits

- [Thejmitchener](https://github.com/thejmitchener)

- [Fuelviews](https://github.com/fuelviews)

- [Spatie](https://github.com/spatie)

- [All Contributors](../../contributors)

## Support us

Fuelviews is a web development agency based in Portland, Maine. You'll find an overview of all our projects [on our website](https://fuelviews.com).

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.