sitemap_generator 6.3.0 → 7.1.1

data/README.md

@@ -1,6 +1,6 @@
 # SitemapGenerator
 
-[![CircleCI](https://circleci.com/gh/kjvarga/sitemap_generator/tree/master.svg?style=shield)](https://circleci.com/gh/kjvarga/sitemap_generator/tree/master)
+[![CI](https://github.com/kjvarga/sitemap_generator/actions/workflows/ci.yml/badge.svg)](https://github.com/kjvarga/sitemap_generator/actions/workflows/ci.yml)
 
 SitemapGenerator is the easiest way to generate Sitemaps in Ruby.  Rails integration provides access to the Rails route helpers within your sitemap config file and automatically makes the rake tasks available to you.  Or if you prefer to use another framework, you can!  You can use the rake tasks provided or run your sitemap configs as plain ruby scripts.
 
@@ -9,16 +9,17 @@ Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.
 ## Features
 
 * Framework agnostic
-* Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], [Mobile sitemaps][sitemap_mobile], [PageMap sitemaps][sitemap_pagemap] and [Alternate Links][alternate_links]
+* Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], Mobile sitemaps *(deprecated)*, [PageMap sitemaps][sitemap_pagemap] and [Alternate Links][alternate_links]
 * Supports read-only filesystems like Heroku via uploading to a remote host like Amazon S3
-* Compatible with all versions of Rails and Ruby
 * Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
 * Handles millions of links
 * Customizable sitemap compression
-* Notifies search engines (Google) of new sitemaps
+* Optional HTTP notification of search engines when `search_engines` is configured
 * Ensures your old sitemaps stay in place if the new sitemap fails to generate
 * Gives you complete control over your sitemap contents and naming scheme
 * Intelligent sitemap indexing
+* Compatible with Ruby from version 2.6 to version 4.0
+* Compatible with Rails from version 6.0 to version 8.1
 
 ### Show Me
 
@@ -26,7 +27,7 @@ This is a simple standalone example.  For Rails installation see the [Rails inst
 
 Install:
 
-```
+```sh
 gem install sitemap_generator
 ```
 
@@ -41,96 +42,87 @@ SitemapGenerator::Sitemap.create do
   add '/home', :changefreq => 'daily', :priority => 0.9
   add '/contact_us', :changefreq => 'weekly'
 end
-SitemapGenerator::Sitemap.ping_search_engines # Not needed if you use the rake tasks
 ```
 
 Run it:
 
-```
+```sh
 ruby sitemap.rb
 ```
 
 Output:
 
-```
+```text
 In /Users/karl/projects/sitemap_generator-test/public/
 + sitemap.xml.gz                                           3 links /  364 Bytes
 Sitemap stats: 3 links / 1 sitemaps / 0m00s
-
-Successful ping of Google
 ```
 
 ## Contents
 
-- [SitemapGenerator](#sitemapgenerator)
-  - [Features](#features)
-    - [Show Me](#show-me)
-  - [Contents](#contents)
-  - [Contribute](#contribute)
-  - [Foreword](#foreword)
-  - [Installation](#installation)
-    - [Ruby](#ruby)
-    - [Rails](#rails)
-  - [Getting Started](#getting-started)
-    - [Preventing Output](#preventing-output)
-    - [Rake Tasks](#rake-tasks)
-    - [Pinging Search Engines](#pinging-search-engines)
-    - [Crontab](#crontab)
-    - [Robots.txt](#robotstxt)
-    - [Ruby Modules](#ruby-modules)
-    - [Deployments & Capistrano](#deployments--capistrano)
-    - [Sitemaps with no Index File](#sitemaps-with-no-index-file)
-    - [Upload Sitemaps to a Remote Host using Adapters](#upload-sitemaps-to-a-remote-host-using-adapters)
-      - [Supported Adapters](#supported-adapters)
-        - [`SitemapGenerator::FileAdapter`](#sitemapgeneratorfileadapter)
-        - [`SitemapGenerator::FogAdapter`](#sitemapgeneratorfogadapter)
-        - [`SitemapGenerator::S3Adapter`](#sitemapgenerators3adapter)
-        - [`SitemapGenerator::AwsSdkAdapter`](#sitemapgeneratorawssdkadapter)
-        - [`SitemapGenerator::WaveAdapter`](#sitemapgeneratorwaveadapter)
-        - [`SitemapGenerator::GoogleStorageAdapter`](#sitemapgeneratorgooglestorageadapter)
-      - [An Example of Using an Adapter](#an-example-of-using-an-adapter)
-    - [Generating Multiple Sitemaps](#generating-multiple-sitemaps)
-  - [Sitemap Configuration](#sitemap-configuration)
-    - [A Simple Example](#a-simple-example)
-    - [Adding Links](#adding-links)
-    - [Supported Options to `add`](#supported-options-to-add)
-    - [Adding Links to the Sitemap Index](#adding-links-to-the-sitemap-index)
-    - [Accessing the LinkSet instance](#accessing-the-linkset-instance)
-    - [Speeding Things Up](#speeding-things-up)
-  - [Customizing your Sitemaps](#customizing-your-sitemaps)
-    - [Sitemap Options](#sitemap-options)
-  - [Sitemap Groups](#sitemap-groups)
-    - [A Groups Example](#a-groups-example)
-    - [Using `group` without a block](#using-group-without-a-block)
-  - [Sitemap Extensions](#sitemap-extensions)
-    - [News Sitemaps](#news-sitemaps)
-      - [Example](#example)
-      - [Supported options](#supported-options)
-    - [Image Sitemaps](#image-sitemaps)
-      - [Example](#example-1)
-      - [Supported options](#supported-options-1)
-    - [Video Sitemaps](#video-sitemaps)
-      - [Example](#example-2)
-      - [Supported options](#supported-options-2)
-    - [PageMap Sitemaps](#pagemap-sitemaps)
-      - [Supported options](#supported-options-3)
-      - [Example:](#example-3)
-    - [Alternate Links](#alternate-links)
-      - [Example](#example-4)
-      - [Supported options](#supported-options-4)
-      - [Alternates Example](#alternates-example)
-    - [Mobile Sitemaps](#mobile-sitemaps)
-      - [Example](#example-5)
-      - [Supported options](#supported-options-5)
-  - [Compatibility](#compatibility)
-  - [Licence](#licence)
-
-## Contribute
-
-Does your website use SitemapGenerator to generate Sitemaps?  Where would you be without Sitemaps?  Probably still knocking rocks together.  Consider donating to the project to keep it up-to-date and open source.
-
-<a href='http://www.pledgie.com/campaigns/15267'><img alt='Click here to lend your support to: SitemapGenerator and make a donation at www.pledgie.com !' src='http://pledgie.com/campaigns/15267.png?skin_name=chrome' border='0' /></a>
-
+* [SitemapGenerator](#sitemapgenerator)
+  * [Features](#features)
+    * [Show Me](#show-me)
+  * [Contents](#contents)
+  * [Foreword](#foreword)
+  * [Installation](#installation)
+    * [Ruby](#ruby)
+    * [Rails](#rails)
+  * [Getting Started](#getting-started)
+    * [Preventing Output](#preventing-output)
+    * [Rake Tasks](#rake-tasks)
+    * [Pinging Search Engines](#pinging-search-engines)
+    * [Crontab](#crontab)
+    * [Robots.txt](#robotstxt)
+    * [Ruby Modules](#ruby-modules)
+    * [Deployments \& Capistrano](#deployments--capistrano)
+    * [Sitemaps with no Index File](#sitemaps-with-no-index-file)
+    * [Upload Sitemaps to a Remote Host using Adapters](#upload-sitemaps-to-a-remote-host-using-adapters)
+      * [Supported Adapters](#supported-adapters)
+        * [`SitemapGenerator::FileAdapter`](#sitemapgeneratorfileadapter)
+        * [`SitemapGenerator::ActiveStorageAdapter`](#sitemapgeneratoractivestorageadapter)
+        * [`SitemapGenerator::FogAdapter`](#sitemapgeneratorfogadapter)
+        * [`SitemapGenerator::S3Adapter`](#sitemapgenerators3adapter)
+        * [`SitemapGenerator::AwsSdkAdapter`](#sitemapgeneratorawssdkadapter)
+        * [`SitemapGenerator::WaveAdapter`](#sitemapgeneratorwaveadapter)
+        * [`SitemapGenerator::GoogleStorageAdapter`](#sitemapgeneratorgooglestorageadapter)
+      * [An Example of Using an Adapter](#an-example-of-using-an-adapter)
+    * [Generating Multiple Sitemaps](#generating-multiple-sitemaps)
+  * [Sitemap Configuration](#sitemap-configuration)
+    * [A Simple Example](#a-simple-example)
+    * [Adding Links](#adding-links)
+    * [Supported Options to `add`](#supported-options-to-add)
+    * [Adding Links to the Sitemap Index](#adding-links-to-the-sitemap-index)
+    * [Accessing the LinkSet instance](#accessing-the-linkset-instance)
+    * [Using `create` without a block](#using-create-without-a-block)
+    * [Speeding Things Up](#speeding-things-up)
+  * [Customizing your Sitemaps](#customizing-your-sitemaps)
+    * [Sitemap Options](#sitemap-options)
+  * [Sitemap Groups](#sitemap-groups)
+    * [A Groups Example](#a-groups-example)
+    * [Using `group` without a block](#using-group-without-a-block)
+  * [Sitemap Extensions](#sitemap-extensions)
+    * [News Sitemaps](#news-sitemaps)
+      * [Example](#example)
+      * [Supported options](#supported-options)
+    * [Image Sitemaps](#image-sitemaps)
+      * [Example](#example-1)
+      * [Supported options](#supported-options-1)
+    * [Video Sitemaps](#video-sitemaps)
+      * [Example](#example-2)
+      * [Supported options](#supported-options-2)
+    * [PageMap Sitemaps](#pagemap-sitemaps)
+      * [Supported options](#supported-options-3)
+      * [Example:](#example-3)
+    * [Alternate Links](#alternate-links)
+      * [Example](#example-4)
+      * [Supported options](#supported-options-4)
+      * [Alternates Example](#alternates-example)
+    * [Mobile Sitemaps](#mobile-sitemaps)
+      * [Example](#example-5)
+      * [Supported options](#supported-options-5)
+  * [Compatibility](#compatibility)
+  * [Licence](#licence)
 
 ## Foreword
 
@@ -140,12 +132,11 @@ Those who knew him know what an amazing guy he was, and what an excellent Rails
 
 The canonical repository is: [http://github.com/kjvarga/sitemap_generator][canonical_repo]
 
-
 ## Installation
 
 ### Ruby
 
-```
+```sh
 gem install 'sitemap_generator'
 ```
 
@@ -159,7 +150,7 @@ The Rake tasks expect your sitemap to be at `config/sitemap.rb` but if you need
 
 ### Rails
 
-SitemapGenerator works with all versions of Rails and has been tested in Rails 2, 3 and 4.
+SitemapGenerator targets Rails 6.0 through 8.1 (see [Compatibility](#compatibility)).
 
 Add the gem to your `Gemfile`:
 
@@ -204,10 +195,10 @@ SitemapGenerator.verbose = false
 
 ### Pinging Search Engines
 
-Using `rake sitemap:refresh` will notify Google to let them know that a new sitemap
+Using `rake sitemap:refresh` will notify configured search engines to let them know that a new sitemap
 is available.  To generate new sitemaps without notifying search engines, use `rake sitemap:refresh:no_ping`.
 
-If you want to customize the hash of search engines you can access it at:
+By default no search engines are configured. If you want to customize the hash of search engines you can access it at:
 
 ```ruby
 SitemapGenerator::Sitemap.search_engines
@@ -224,7 +215,7 @@ directly in the call, as in the following example:
 SitemapGenerator::Sitemap.ping_search_engines(newengine: 'http://newengine.com/ping?url=%s')
 ```
 
-The key gives the name of the search engine, as a string or symbol, and the value is the full URL to ping, with a string interpolation that will be replaced by the CGI escaped sitemap index URL.  If you have any literal percent characters in your URL you need to escape them with `%%`.
+The key gives the name of the search engine, as a string or symbol, and the value is the full URL to ping, with a string interpolation that will be replaced by the URL-encoded (percent-encoded) sitemap index URL.  If you have any literal percent characters in your URL you need to escape them with `%%`.
 
 If you are calling `SitemapGenerator::Sitemap.ping_search_engines` from outside of your sitemap config file, then you will need to set `SitemapGenerator::Sitemap.default_host` and any other options that you set in your sitemap config which affect the location of the sitemap index file.  For example:
 
@@ -256,7 +247,7 @@ end
 
 You should add the URL of the sitemap index file to `public/robots.txt` to help search engines find your sitemaps.  The URL should be the complete URL to the sitemap index.  For example:
 
-```
+```text
 Sitemap: http://www.example.com/sitemap.xml.gz
 ```
 
@@ -317,6 +308,7 @@ To never create an index:
 ```ruby
 SitemapGenerator::Sitemap.create_index = false
 ```
+
 Your sitemaps will still be called `sitemap.xml.gz`, `sitemap1.xml.gz`, `sitemap2.xml.gz`, etc.
 
 And the default "intelligent" behaviour:
@@ -342,6 +334,10 @@ directory.
 
   Standard adapter, writes out to a file.
 
+##### `SitemapGenerator::ActiveStorageAdapter`
+
+  Uses `ActiveStorage::Blob` to store the sitemap.
+
 ##### `SitemapGenerator::FogAdapter`
 
   Uses `Fog::Storage` to upload to any service supported by Fog.
@@ -364,6 +360,7 @@ directory.
   Where `options` is a Hash with any of the following keys:
 * `aws_access_key_id` [String] Your AWS access key id
 * `aws_secret_access_key` [String] Your AWS secret access key
+* `aws_session_token` [String] Session token for temporary credentials (optional)
 * `fog_provider` [String]
 * `fog_directory` [String]
 * `fog_region` [String]
@@ -372,7 +369,7 @@ directory.
 * `fog_public` [Boolean] Whether the file is publicly accessible
 
 Alternatively you can use an environment variable to configure each option (except `fog_storage_options`).  The environment variables have the same
-name but capitalized, e.g. `FOG_PATH_STYLE`.
+name but capitalized, e.g. `AWS_SESSION_TOKEN`, `FOG_PATH_STYLE`.
 
 ##### `SitemapGenerator::AwsSdkAdapter`
 
@@ -388,14 +385,15 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
   SitemapGenerator::Sitemap.adapter = SitemapGenerator::AwsSdkAdapter.new('s3_bucket',
     acl: 'public-read', # Optional. This is the default.
     cache_control: 'private, max-age=0, no-cache', # Optional. This is the default.
-    access_key_id: 'AKIAI3SW5CRAZBL4WSTA',
-    secret_access_key: 'asdfadsfdsafsadf',
+    access_key_id: 'YOUR_AWS_ACCESS_KEY_ID',
+    secret_access_key: 'YOUR_AWS_SECRET_ACCESS_KEY',
+    session_token: 'YOUR_AWS_SESSION_TOKEN', # Optional; use with temporary credentials.
     region: 'us-east-1',
     endpoint: 'https://sfo2.digitaloceanspaces.com'
   )
   ```
 
-  Where the first argument is the S3 bucket name, and the rest are keyword argument options.  Options `:acl` and `:cache_control` configure access and caching of the uploaded files; all other options are passed directly to the AWS client.
+  Where the first argument is the S3 bucket name, and the rest are keyword argument options.  Options `:acl` and `:cache_control` configure access and caching of the uploaded files; `session_token` supports STS-style credentials (or set `AWS_SESSION_TOKEN` and rely on SDK defaults). All other keyword options are passed directly to the AWS client.
 
   See [the `SitemapGenerator::AwsSdkAdapter` docs](https://github.com/kjvarga/sitemap_generator/blob/master/lib/sitemap_generator/adapters/aws_sdk_adapter.rb), and [https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Client.html#initialize-instance_method](https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Client.html#initialize-instance_method) for the full list of supported options.
 
@@ -425,6 +423,7 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
     project_id: 'google_account_project_id',
   )
   ```
+
   Also, inline with Google Authentication options, it can also pick credentials from environment variables. All [supported environment variables][google_cloud_storage_authentication] can be used, for example: `GOOGLE_CLOUD_PROJECT` and `GOOGLE_CLOUD_CREDENTIALS`.  An example of using this adapter with the environment variables is:
 
   ```ruby
@@ -440,7 +439,7 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
 1. Please see [this wiki page][remote_hosts] for more information about setting up SitemapGenerator to upload to a
    remote host.
 
-2. This example uses the CarrierWave adapter.  It shows some common settings that are used when the hostname hosting
+1. This example uses the CarrierWave adapter.  It shows some common settings that are used when the hostname hosting
    the sitemaps differs from the hostname of the sitemap links.
 
      ```ruby
@@ -460,9 +459,9 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
      SitemapGenerator::Sitemap.adapter = SitemapGenerator::WaveAdapter.new
      ```
 
-3. Update your `robots.txt` file to point robots to the remote sitemap index file, e.g:
+1. Update your `robots.txt` file to point robots to the remote sitemap index file, e.g:
 
-    ```
+    ```text
     Sitemap: http://s3.amazonaws.com/sitemap-generator/sitemaps/sitemap.xml.gz
     ```
 
@@ -473,7 +472,7 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
     that would otherwise be included would point to a different host than the rest of the links
     in the sitemap, something that the sitemap rules forbid.
 
-4. Verify to Google that you own the S3 url
+1. Verify to Google that you own the S3 url
 
     In order for Google to use your sitemap, you need to prove you own the S3 bucket through [google webmaster tools](https://www.google.com/webmasters/tools/home?hl=en).  In the example above, you would add the site `http://s3.amazonaws.com/sitemap-generator/sitemaps`.  Once you have verified you own the directory, then add your
     sitemap index to the list of sitemaps for the site.
@@ -499,7 +498,7 @@ end
 
 Outputs:
 
-```
+```text
 + sitemaps/google/sitemap1.xml.gz             2 links /  822 Bytes /  328 Bytes gzipped
 + sitemaps/google/sitemap.xml.gz           1 sitemaps /  389 Bytes /  217 Bytes gzipped
 Sitemap stats: 2 links / 1 sitemaps / 0m00s
@@ -536,10 +535,9 @@ SitemapGenerator::Sitemap.create do
 end
 ```
 
-
 To generate each one specify the configuration file to run by passing the `CONFIG_FILE` option to `rake sitemap:refresh`, e.g.:
 
-```
+```sh
 rake sitemap:refresh CONFIG_FILE="config/google_sitemap.rb"
 rake sitemap:refresh CONFIG_FILE="config/apple_sitemap.rb"
 rake sitemap:refresh CONFIG_FILE="config/bing_sitemap.rb"
@@ -551,7 +549,7 @@ A sitemap configuration file contains all the information needed to generate you
 
 If you want to use a non-standard configuration file, or have multiple configuration files, you can specify which one to run by passing the `CONFIG_FILE` option like so:
 
-```
+```sh
 rake sitemap:refresh CONFIG_FILE="config/geo_sitemap.rb"
 ```
 
@@ -575,7 +573,7 @@ A few things to note:
 
 Now let's see what is output when we run this configuration with `rake sitemap:refresh:no_ping`:
 
-```
+```text
 In /Users/karl/projects/sitemap_generator-test/public/
 + sitemap.xml.gz                                           2 links /  347 Bytes
 Sitemap stats: 2 links / 1 sitemaps / 0m00s
@@ -585,7 +583,6 @@ Weird!  The sitemap has two links, even though we only added one!  This is becau
 
 Now let's take a look at the file that was created.  After uncompressing and XML-tidying the contents we have:
 
-
 * `public/sitemap.xml.gz`
 
 ```xml
@@ -620,7 +617,7 @@ end
 
 And the output:
 
-```
+```text
 In /Users/karl/projects/sitemap_generator-test/public/
 + sitemap1.xml.gz                                          2 links /  347 Bytes
 + sitemap.xml.gz                                        1 sitemaps /  228 Bytes
@@ -665,7 +662,7 @@ In the example about we pass a `lastmod` (last modified) option with the value o
 
 Looking at the output from running this sitemap, we see that we have a few more links than before:
 
-```
+```text
 + sitemap.xml.gz                   12 links /     2.3 KB /  365 Bytes gzipped
 Sitemap stats: 12 links / 1 sitemaps / 0m00s
 ```
@@ -773,18 +770,28 @@ end
 
 The output looks something like this:
 
-```
+```text
 In /Users/karl/projects/sitemap_generator-test/public/
 + sitemap4.xml.gz                                          3 links /  355 Bytes
 + sitemap.xml.gz                                        4 sitemaps /  242 Bytes
 Sitemap stats: 3 links / 4 sitemaps / 0m00s
 ```
 
+### Using `create` without a block
+
+You can call `create` without a block, add links (and use `group` as needed), then call `finalize!` on the returned link set when finished.
+
+```ruby
+sitemap = SitemapGenerator::Sitemap.create(default_host: 'http://www.example.com')
+sitemap.add('/home')
+# ... add more links or use groups, then:
+sitemap.finalize!
+```
+
 ### Speeding Things Up
 
 For large ActiveRecord collections with thousands of records it is advisable to iterate through them in batches to avoid loading all records into memory at once.  For this reason in the example above we use `Content.find_each` which is a batched iterator available since Rails 2.3.2, rather than `Content.all`.
 
-
 ## Customizing your Sitemaps
 
 SitemapGenerator supports a number of options which allow you to control every aspect of your sitemap generation.  How they are named, where they are stored, the contents of the links and the location that the sitemaps will be hosted from can all be set.
@@ -841,8 +848,8 @@ The following options are supported.
 * `:public_path` - String.  A **full or relative path** to the `public` directory or the directory you want to write sitemaps into.  Defaults to `public/` under your application root or relative to the current working directory.
 
 * `:sitemaps_host` - String.  **Host including protocol** to use when generating a link to a sitemap file i.e. the hostname of the server where the sitemaps are hosted.  The value will differ from the hostname in your sitemap links.  For example: `'http://amazon.aws.com/'`.  Note that `include_index` is
-automatically turned off when the `sitemaps_host` does not match `default_host`.
-Because the link to the sitemap index file that would otherwise be added would point to a different host than the rest of the links in the sitemap.  Something that the sitemap rules forbid.
+  automatically turned off when the `sitemaps_host` does not match `default_host`.
+  Because the link to the sitemap index file that would otherwise be added would point to a different host than the rest of the links in the sitemap.  Something that the sitemap rules forbid.
 
 * `:namer` - A `SitemapGenerator::SimpleNamer` instance **for generating sitemap names**.  You can read about Sitemap Namers by reading the API docs.  Allows you to set the name, extension and number sequence for sitemap files, as well as modify the name of the first file in the sequence, which is often the index file.  A simple example if we want to generate files like 'newname.xml.gz', 'newname1.xml.gz', etc is `SitemapGenerator::SimpleNamer.new(:newname)`.
 
@@ -853,9 +860,9 @@ Because the link to the sitemap index file that would otherwise be added would p
 * `:adapter` - Instance.  The default adapter is a `SitemapGenerator::FileAdapter` which simply writes files to the filesystem.  You can use a `SitemapGenerator::WaveAdapter` for uploading sitemaps to remote servers - useful for read-only hosts such as Heroku.  Or you can provide an instance of your own class to provide custom behavior.  Your class must define a write method which takes a `SitemapGenerator::Location` and raw XML data.
 
 * `:compress` - Specifies which files to compress with gzip.  Default is `true`. Accepted values:
-    * `true` - Boolean; compress all files.
-    * `false` - Boolean; Do not compress any files.
-    * `:all_but_first` - Symbol; leave the first file uncompressed but compress all remaining files.
+  * `true` - Boolean; compress all files.
+  * `false` - Boolean; Do not compress any files.
+  * `:all_but_first` - Symbol; leave the first file uncompressed but compress all remaining files.
 
   The compression setting applies to groups too.  So `:all_but_first` will have the same effect (the first file in the group will not be compressed, the rest will).  So if you require different behaviour for your groups, pass in a `:compress` option e.g. `group(:compress => false) { add('/link') }`
 
@@ -896,7 +903,7 @@ end
 
 And the output from running the above:
 
-```
+```text
 In /Users/karl/projects/sitemap_generator-test/public/
 + en/english.xml.gz                                        1 links /  328 Bytes
 + fr/french.xml.gz                                         1 links /  329 Bytes
@@ -945,7 +952,7 @@ end
 
 And the output from running the above:
 
-```
+```text
 In '/Users/kvarga/Projects/sitemap_generator-test/public/':
 + odds.xml.gz                                             10 links /  371 Bytes
 + evens.xml.gz                                            10 links /  371 Bytes
@@ -980,14 +987,14 @@ end
 #### Supported options
 
 * `:news` - Hash
-    * `:publication_name`
-    * `:publication_language`
-    * `:publication_date`
-    * `:genres`
-    * `:access`
-    * `:title`
-    * `:keywords`
-    * `:stock_tickers`
+  * `:publication_name`
+  * `:publication_language`
+  * `:publication_date`
+  * `:genres`
+  * `:access`
+  * `:title`
+  * `:keywords`
+  * `:stock_tickers`
 
 ### Image Sitemaps
 
@@ -1007,11 +1014,11 @@ end
 #### Supported options
 
 * `:images` - Array of hashes
-    * `:loc` Required, location of the image
-    * `:caption`
-    * `:geo_location`
-    * `:title`
-    * `:license`
+  * `:loc` Required, location of the image
+  * `:caption`
+  * `:geo_location`
+  * `:title`
+  * `:license`
 
 ### Video Sitemaps
 
@@ -1038,32 +1045,32 @@ end
 #### Supported options
 
 * `:video` or `:videos` - Hash or array of hashes, respectively
-    * `:thumbnail_loc` - Required.  String, URL of the thumbnail image.
-    * `:title` - Required.  String, title of the video.
-    * `:description` - Required.  String, description of the video.
-    * `:content_loc` - Depends. String, URL.  One of content_loc or player_loc must be present.
-    * `:player_loc` - Depends. String, URL.  One of content_loc or player_loc must be present.
-    * `:allow_embed` - Boolean, attribute of player_loc.
-    * `:autoplay` - Boolean, default true.  Attribute of player_loc.
-    * `:duration` - Recommended. Integer or string.  Duration in seconds.
-    * `:expiration_date` - Recommended when applicable.  The date after which the video will no longer be available.
-    * `:rating` - Optional
-    * `:view_count` - Optional. Integer or string.
-    * `:publication_date` - Optional
-    * `:tags` - Optional. Array of string tags.
-    * `:tag` - Optional. String, single tag.
-    * `:category` - Optional
-    * `:family_friendly`- Optional. Boolean
-    * `:gallery_loc` - Optional. String, URL.
-    * `:gallery_title` - Optional. Title attribute of the gallery location element
-    * `:uploader` - Optional.
-    * `:uploader_info` - Optional. Info attribute of uploader element
-    * `:price` - Optional. Only one price supported at this time
-        * `:price_currency` - Required.  In [ISO_4217][iso_4217] format.
-        * `:price_type` - Optional. `rent` or `own`
-        * `:price_resolution` - Optional. `HD` or `SD`
-    * `:live` - Optional. Boolean.
-    * `:requires_subscription` - Optional. Boolean.
+  * `:thumbnail_loc` - Required.  String, URL of the thumbnail image.
+  * `:title` - Required.  String, title of the video.
+  * `:description` - Required.  String, description of the video.
+  * `:content_loc` - Depends. String, URL.  One of content_loc or player_loc must be present.
+  * `:player_loc` - Depends. String, URL.  One of content_loc or player_loc must be present.
+  * `:allow_embed` - Boolean, attribute of player_loc.
+  * `:autoplay` - Boolean, default true.  Attribute of player_loc.
+  * `:duration` - Recommended. Integer or string.  Duration in seconds.
+  * `:expiration_date` - Recommended when applicable.  The date after which the video will no longer be available.
+  * `:rating` - Optional
+  * `:view_count` - Optional. Integer or string.
+  * `:publication_date` - Optional
+  * `:tags` - Optional. Array of string tags.
+  * `:tag` - Optional. String, single tag.
+  * `:category` - Optional
+  * `:family_friendly`- Optional. Boolean
+  * `:gallery_loc` - Optional. String, URL.
+  * `:gallery_title` - Optional. Title attribute of the gallery location element
+  * `:uploader` - Optional.
+  * `:uploader_info` - Optional. Info attribute of uploader element
+  * `:price` - Optional. Only one price supported at this time
+  * `:price_currency` - Required.  In [ISO_4217][iso_4217] format.
+  * `:price_type` - Optional. `rent` or `own`
+  * `:price_resolution` - Optional. `HD` or `SD`
+  * `:live` - Optional. Boolean.
+  * `:requires_subscription` - Optional. Boolean.
 
 ### PageMap Sitemaps
 
@@ -1072,14 +1079,14 @@ Pagemaps can be added by passing a `:pagemap` hash to `add`. The hash must conta
 #### Supported options
 
 * `:pagemap` - Hash
-    * `:dataobjects` - Required, array of hashes
-        * `:type` - Required, string, type of the object
-        * `:id` - String, ID of the object
-        * `:attributes` - Array of hashes
-            * `:name` - Required, string, name of the attribute.
-            * `:value` - String, value of the attribute.
+  * `:dataobjects` - Required, array of hashes
+    * `:type` - Required, string, type of the object
+    * `:id` - String, ID of the object
+    * `:attributes` - Array of hashes
+      * `:name` - Required, string, name of the attribute.
+      * `:value` - String, value of the attribute.
 
-#### Example:
+#### Example
 
 ```ruby
 SitemapGenerator::Sitemap.default_host = "http://www.example.com"
@@ -1121,10 +1128,10 @@ end
 #### Supported options
 
 * `:alternate`/`:alternates` - Hash or array of hashes, respectively
-    * `:href` - Required, string.
-    * `:lang`  - Optional, string.
-    * `:nofollow` - Optional, boolean. Used to mark link as "nofollow".
-    * `:media` - Optional, string.  Specify [media targets for responsive design pages][media].
+  * `:href` - Required, string.
+  * `:lang`  - Optional, string.
+  * `:nofollow` - Optional, boolean. Used to mark link as "nofollow".
+  * `:media` - Optional, string.  Specify [media targets for responsive design pages][media].
 
 #### Alternates Example
 
@@ -1150,7 +1157,7 @@ end
 
 Mobile sitemaps include a specific `<mobile:mobile/>` tag.
 
-Check out the Google specification [here][sitemap_mobile].
+> **Deprecated**: Google deprecated mobile sitemaps in August 2022. No other major search engines supported this format. Responsive design is the recommended approach for mobile-friendly content.
 
 #### Example
 
@@ -1167,25 +1174,23 @@ end
 
 ## Compatibility
 
-Compatible with all versions of Rails and Ruby.  Tested up to Ruby 3.1 and Rails 7.0.
-Ruby 1.9.3 support was dropped in Version 6.0.0.
+Ruby 2.6 through 4.0 and Rails 6.0 through 8.1 are supported.
+Ruby 2.5 and Rails 5.2 were dropped in v7.0.0.
+Ruby 1.9.3 support was dropped in v6.0.0.
 
 ## Licence
 
-Released under the MIT License.  See the (MIT-LICENSE)[MIT-LICENSE] file.
-
-MIT. See the LICENSE.md file.
+Released under the MIT license which is included in the [MIT-LICENSE](./MIT-LICENSE) file.
 
-Copyright (c) Karl Varga released under the MIT license
+Copyright (c) Karl Varga
 
 [canonical_repo]:http://github.com/kjvarga/sitemap_generator
 [sitemap_images]:http://www.google.com/support/webmasters/bin/answer.py?answer=178636
 [sitemap_video]:https://support.google.com/webmasters/answer/80471?hl=en&ref_topic=4581190
 [sitemap_news]:https://support.google.com/news/publisher/topic/2527688?hl=en&ref_topic=4359874
-[sitemap_mobile]:http://support.google.com/webmasters/bin/answer.py?hl=en&answer=34648
 [sitemap_pagemap]:https://developers.google.com/custom-search/docs/structured_data#addtositemap
 [sitemap_protocol]:http://www.sitemaps.org/protocol.html
-[video_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=80472#4
+[video_tags]:https://developers.google.com/search/docs/crawling-indexing/sitemaps/video-sitemaps
 [image_tags]:http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=178636
 [news_tags]:http://www.google.com/support/news_pub/bin/answer.py?answer=74288
 [remote_hosts]:https://github.com/kjvarga/sitemap_generator/wiki/Generate-Sitemaps-on-read-only-filesystems-like-Heroku
@@ -1193,7 +1198,7 @@ Copyright (c) Karl Varga released under the MIT license
 [using_pagemaps]:https://developers.google.com/custom-search/docs/structured_data#pagemaps
 [iso_4217]:http://en.wikipedia.org/wiki/ISO_4217
 [media]:https://developers.google.com/webmasters/smartphone-sites/details
-[expires]:https://support.google.com/customsearch/answer/2631051?hl=en
+[expires]:https://support.google.com/webmasters/answer/9689846
 [google_cloud_storage_gem]:https://rubygems.org/gems/google-cloud-storage
 [google_cloud_storage_authentication]:https://googleapis.dev/ruby/google-cloud-storage/latest/file.AUTHENTICATION.html
 [google_cloud_storage_initializer]:https://github.com/googleapis/google-cloud-ruby/blob/master/google-cloud-storage/lib/google/cloud/storage.rb