commit fonctionne ou pas ?

2022-11-30 17:27:28 +01:00
commit e9dd38c3a8
3397 changed files with 593718 additions and 0 deletions
@@ -0,0 +1,137 @@
+# Grav Sitemap Plugin
+
+`Sitemap` is a [Grav](http://github.com/getgrav/grav) Plugin that generates a [map of your pages](http://en.wikipedia.org/wiki/Site_map) in `XML` format that is easily understandable and indexable by Search engines.
+
+# Installation
+
+Installing the Sitemap plugin can be done in one of two ways. Our GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
+
+## GPM Installation (Preferred)
+
+The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line).  From the root of your Grav install type:
+
+    bin/gpm install sitemap
+
+This will install the Sitemap plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/sitemap`.
+
+## Manual Installation
+
+To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `sitemap`. You can find these files either on [GitHub](https://github.com/getgrav/grav-plugin-sitemap) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).
+
+You should now have all the plugin files under
+
+    /your/site/grav/user/plugins/sitemap
+
+>> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav), the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-problems) plugins, and a theme to be installed in order to operate.
+
+
+# Usage
+
+The `sitemap` plugin works out of the box. You can just go directly to `http://yoursite.com/sitemap` and you will see the generated `XML`.
+
+## Config Defaults
+
+```
+enabled: true
+route: '/sitemap'
+ignore_external: true
+ignore_protected: true
+ignore_redirect: true
+ignores:
+  - /blog/blog-post-to-ignore
+  - /ignore-this-route
+  - /ignore-children-of-this-route/.*
+whitelist:
+html_support: false
+urlset: 'http://www.sitemaps.org/schemas/sitemap/0.9'
+short_date_format: true
+include_changefreq: true
+changefreq: daily
+include_priority: true
+priority: !!float 1
+additions:
+  -
+    location: /something-special
+    lastmod: '2020-04-16'
+    changefreq: hourly
+    priority: 0.3
+  -
+    location: /something-else
+    lastmod: '2020-04-17'
+    changefreq: weekly
+    priority: 0.2
+```
+
+You can ignore your own pages by providing a list of routes to ignore. You can also use a page's Frontmatter to signal that the sitemap should ignore it:
+
+```
+sitemap:
+    ignore: true
+```
+
+## Multi-Language Support
+
+The latest Sitemap `v3.0` includes all new multi-language support utilizing the latest [Google Search SEO Recomendations](https://developers.google.com/search/docs/advanced/crawling/localized-versions?hl=en&visit_id=637468720624267418-280936473&rd=2) which creates bi-directional `hreflang` entries for each language available.
+
+This is handled automatically based on your Grav multi-language System configuration.
+
+## Images
+
+You can add images to the sitemap by adding an entry in the page's Frontmatter.
+
+```
+sitemap:
+    images:
+        your_image:
+            loc: your-image.png
+            caption: A caption for the image
+            geoloc: Amsterdam, The Netherlands
+            title: The title of your image
+            license: A URL to the license of the image.
+```
+
+For more info on images in sitemaps see [Google image sitemaps](https://support.google.com/webmasters/answer/178636?hl=en).
+
+## Only allow access to the .xml file
+
+If you want your sitemap to only be accessible via `sitemap.xml` for example, set the route to `/sitemap` and add this to your `.htaccess` file:
+
+`Redirect 301 /sitemap /sitemap.xml`
+
+## HTML Support
+
+As of Sitemap version `3.0.1` you can enable `html_support` in the configuration and then when you go to `/sitemap` or `/sitemap.html` you will view an HTML version of the sitemap per the `templates/sitemap.html.twig` template.  
+
+You can copy and extend this Twig template in your theme to customize it for your needs.
+
+## Manually add pages to the sitemap
+
+You can manually add URLs to the sitemap using the Admin settings, or by adding entries to your `sitemap.yaml` with this format:
+
+```
+additions:
+  -
+    location: /something-special
+    lastmod: '2020-04-16'
+    changefreq: hourly
+    priority: 0.3
+```
+Note that Regex support is available: Just append `.*` to a path to ignore all of it's children.
+
+## Dynamically adding pages to the sitemap
+
+If you have some dynamic content being added to your site via another plugin, or perhaps a 3rd party API, you can now add them dynamically to the sitemap with a simple event:
+
+Make sure you are subscribed to the `` event then add simply add your entry to the sitemap like this:
+
+```php
+    public function onSitemapProcessed(\RocketTheme\Toolbox\Event\Event $e)
+    {
+        $sitemap = $e['sitemap'];
+        $location = \Grav\Common\Utils::url('/foo-location', true);
+        $sitemap['/foo'] = new \Grav\Plugin\Sitemap\SitemapEntry($location, '2020-07-02', 'weekly', '2.0');
+        $e['sitemap'] = $sitemap;
+    }
+```
+
+The use `Utils::url()` method allow us to easily create the correct full URL by passing it a route plus the optional `true` parameter.