GitHub Pages can automatically create sitemaps for your projects.
Note: GitHub Pages will not override a sitemap.xml file that exists in the root of your repository.
Setting up
To enable automatic sitemap generation, you must add the following line to your site's _config.yml file:
gems:
- jekyll-sitemap
If you don't have a _config.yml file, you will need to create one in the root of your GitHub Pages repository. For more information, see Jekyll's official plugins documentation.
Testing locally
To preview the output of your sitemap locally:
- Add
jekyll-sitemapto your site's _config.yml file - Make sure you're using the latest version of the GitHub Pages Gem, which contains these dependencies and plugins.
You should see a new sitemap.xml file generated in your Jekyll _site folder.
For more information, see The Jekyll Sitemap Gem.
