Laravel IndexNow

https://github.com/ymigval/laravel-indexnow
Admin
A Laravel package that simplifies integration with the IndexNow API, allowing real-time notification...
Tokens:831
Snippets:12
Trust Score:6.9
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Laravel IndexNow Composer Dependencies

Source: https://github.com/ymigval/laravel-indexnow/blob/main/CONTRIBUTING.md

Command to install the necessary PHP dependencies for the Laravel IndexNow project using Composer after cloning the repository.

```Bash
composer install
```

--------------------------------

### Install Laravel IndexNow Package via Composer

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Installs the Laravel IndexNow package using Composer, making it available for use in your project. This is the first step to integrate IndexNow functionality into your Laravel application.

```Shell Script
composer require ymigval/laravel-indexnow
```

--------------------------------

### Clone Laravel IndexNow Repository and Navigate

Source: https://github.com/ymigval/laravel-indexnow/blob/main/CONTRIBUTING.md

Instructions to clone your forked Laravel IndexNow repository from GitHub and navigate into its directory using Git and Bash commands.

```Bash
git clone https://github.com/your-username/laravel-indexnow.git
cd laravel-indexnow
```

--------------------------------

### View Current IndexNow API Key

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Displays the currently configured IndexNow API key using an Artisan command. This is useful for quickly verifying that your API key is correctly set up in your environment.

```Shell Script
php artisan indexnow:apikey
```

--------------------------------

### View Laravel IndexNow Action Logs

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Displays a log of all actions performed by the Laravel IndexNow package. This command is useful for monitoring successful submissions, identifying errors, and debugging any issues related to IndexNow API interactions.

```Shell Script
php artisan indexnow:logs
```

--------------------------------

### Create New Git Branch for Feature or Bug Fix

Source: https://github.com/ymigval/laravel-indexnow/blob/main/CONTRIBUTING.md

Command to create and switch to a new Git branch, which is recommended practice for developing a new feature or fixing a bug within the Laravel IndexNow project.

```Bash
git checkout -b feature/your-feature-name
```

--------------------------------

### Publish Laravel IndexNow Configuration File

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Publishes the default configuration file for the Laravel IndexNow package to your application's config directory. This allows you to customize various settings, including search engine targets and logging preferences.

```Shell Script
php artisan vendor:publish --tag="indexnow"
```

--------------------------------

### Submit Multiple URLs to IndexNow API

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Shows two convenient methods for submitting multiple URLs to the IndexNow API: using an array of URLs or chaining multiple setUrl calls. This allows for efficient bulk notifications to search engines.

```PHP
use Ymigval\LaravelIndexnow\Facade\IndexNow;

// Using array
IndexNow::submit([
    'https://www.example.com/page-1',
    'https://www.example.com/page-2',
    'https://www.example.com/page-3'
]);

// Or using method chaining
IndexNow::setUrl('https://www.example.com/page-1')
        ->setUrl('https://www.example.com/page-2')
        ->setUrl('https://www.example.com/page-3')
        ->submit();
```

--------------------------------

### Configure IndexNow API Key in .env

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Adds your generated IndexNow API key to your Laravel project's .env file. This key is crucial for authenticating your requests with the IndexNow API and enabling successful URL submissions.

```Shell Script
INDEXNOW_API_KEY=your_api_key_here
```

--------------------------------

### Submit Single URL to IndexNow API

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Demonstrates how to submit a single URL to the IndexNow API using the package's facade. This method is ideal for notifying search engines immediately when a specific page's content is created, updated, or deleted.

```PHP
use Ymigval\LaravelIndexnow\Facade\IndexNow;

IndexNow::submit('https://www.example.com/my-page');
```

--------------------------------

### Check Laravel IndexNow Package Status

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Provides a comprehensive status check of the Laravel IndexNow package. This command verifies API key configuration, key file accessibility, search engine settings, and overall package health, offering recommendations for any issues.

```Shell Script
php artisan indexnow:status
```

--------------------------------

### Clear and Cache Laravel Routes

Source: https://github.com/ymigval/laravel-indexnow/blob/main/README.md

Clears and then re-caches Laravel routes. This command is often necessary after publishing new configurations or adding new routes to ensure the application recognizes them correctly.

```Shell Script
php artisan route:clear
php artisan route:cache
```
Tokens:
Raw