Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/TryGhost/gatsby-plugin-advanced-sitemap

Advanced XML Sitemaps for Gatsby.js
https://github.com/TryGhost/gatsby-plugin-advanced-sitemap

gatsby gatsby-plugin gatsbyjs seo sitemap-generator static-site

Last synced: 2 months ago
JSON representation

Advanced XML Sitemaps for Gatsby.js

Host: GitHub
URL: https://github.com/TryGhost/gatsby-plugin-advanced-sitemap
Owner: TryGhost
License: mit
Fork: true (taboola/gatsby-plugin-advanced-sitemap)
Created: 2019-02-25T03:32:29.000Z (almost 6 years ago)
Default Branch: main
Last Pushed: 2024-09-01T23:53:21.000Z (5 months ago)
Last Synced: 2024-11-06T05:42:14.266Z (3 months ago)
Topics: gatsby, gatsby-plugin, gatsbyjs, seo, sitemap-generator, static-site
Language: JavaScript
Homepage:
Size: 2.49 MB
Stars: 150
Watchers: 11
Forks: 0
Open Issues: 23
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-list - gatsby-plugin-advanced-sitemap

README

# gatsby-plugin-advanced-sitemap

The default Gatsby sitemap plugin generates a simple blob of raw XML for all your pages. This **advanced sitemap plugin** adds more power and configuration, generating a single or multiple sitemaps with full XSL templates to make them neatly organised and human + machine readable, as well linking image resources to encourage media indexing.

**Demo:** https://gatsby.ghost.org/sitemap.xml

![example](https://user-images.githubusercontent.com/120485/53555088-d27a0280-3b73-11e9-88ca-fb4ec08d9d26.png)

_NOTE: This plugin only generates output in `production` mode! To test, run: `gatsby build && gatsby serve`_

## Install

`npm install --save gatsby-plugin-advanced-sitemap`

## How to Use

By default this plugin will generate a single sitemap of all pages on your site, without any configuration needed.

```javascript
// gatsby-config.js

siteMetadata: {
siteUrl: `https://www.example.com`,
},
plugins: [
`gatsby-plugin-advanced-sitemap`
]
```

## Options

If you want to generate advanced, individually organised sitemaps based on your data, you can do so by passing in a query and config. The example below uses [Ghost](https://ghost.org/), but this should work with any data source - including Pages, Markdown, Contentful, etc.

**Example:**

```javascript
// gatsby-config.js

plugins: [
{
resolve: `gatsby-plugin-advanced-sitemap`,
options: {
// 1 query for each data type
query: `
{
allGhostPost {
edges {
node {
id
slug
updated_at
feature_image
}
}
}
allGhostPage {
edges {
node {
id
slug
updated_at
feature_image
}
}
}
allGhostTag {
edges {
node {
id
slug
feature_image
}
}
}
allGhostAuthor {
edges {
node {
id
slug
profile_image
}
}
}
}`,
// The filepath and name to Index Sitemap. Defaults to '/sitemap.xml'.
output: "/custom-sitemap.xml",
mapping: {
// Each data type can be mapped to a predefined sitemap
// Routes can be grouped in one of: posts, tags, authors, pages, or a custom name
// The default sitemap - if none is passed - will be pages
allGhostPost: {
sitemap: `posts`,
// Add a query level prefix to slugs, Don't get confused with global path prefix from Gatsby
// This will add a prefix to this particular sitemap only
prefix: 'your-prefix/',
// Custom Serializer
serializer: (edges) => {
return edges.map(({ node }) => {
(...) // Custom logic to change final sitemap.
})
}
},
allGhostTag: {
sitemap: `tags`,
},
allGhostAuthor: {
sitemap: `authors`,
},
allGhostPage: {
sitemap: `pages`,
},
},
exclude: [
`/dev-404-page`,
`/404`,
`/404.html`,
`/offline-plugin-app-shell-fallback`,
`/my-excluded-page`,
/(\/)?hash-\S*/, // you can also pass valid RegExp to exclude internal tags for example
],
createLinkInHead: true, // optional: create a link in the `` of your site
addUncaughtPages: true, // optional: will fill up pages that are not caught by queries and mapping and list them under `sitemap-pages.xml`
additionalSitemaps: [ // optional: add additional sitemaps, which are e. g. generated somewhere else, but need to be indexed for this domain
{
name: `my-other-posts`,
url: `/blog/sitemap-posts.xml`,
},
{
url: `https://example.com/sitemap.xml`,
},
],
}
}
]
```

Example output of ☝️ this exact config 👉 https://gatsby.ghost.org/sitemap.xml

## Develop Plugin

- Pull the repo

1. Install dependencies

```bash
yarn install
```

Build Plugin

```bash
yarn build
```

Run Tests

```bash
yarn test
```