An open API service indexing awesome lists of open source software.

https://github.com/nawarian/jigsaw-sitemap-plugin

[WIP] A sitemap generator plugin for Tightenco's Jigsaw
https://github.com/nawarian/jigsaw-sitemap-plugin

Last synced: 21 days ago
JSON representation

[WIP] A sitemap generator plugin for Tightenco's Jigsaw

Awesome Lists containing this project

README

        

Jigsaw Sitemap Plugin
----
[![Build Status](https://travis-ci.org/nawarian/jigsaw-sitemap-plugin.svg?branch=master)](https://travis-ci.org/nawarian/jigsaw-sitemap-plugin)
[![codecov](https://codecov.io/gh/nawarian/jigsaw-sitemap-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/nawarian/jigsaw-sitemap-plugin)

Jigsaw Sitemap Plugin is an easy and straight forward plugin
to be used on Jigsaw's `afterBuild` event.

It fetches all generated pages and generates a sitemap file
containing such entries based on configurations.

### Usage

On your Jigsaw project, require this package:
```bash
$ composer require nawarian/jigsaw-sitemap-plugin
```

On your `bootstrap.php` file, register the Listener:

```php
use Nawarian\JigsawSitemapPlugin\Listener\SitemapListener;

/** @var $container \Illuminate\Container\Container */
/** @var $events \TightenCo\Jigsaw\Events\EventBus */

$events->afterBuild([SitemapListener::class]);
```

After running the build you should see a `sitemap.xml` file
inside build's output folder.