https://github.com/nymag/clay-sitemaps

A suite of tools for adding sitemaps to Clay sites.
https://github.com/nymag/clay-sitemaps

Last synced: 14 days ago
JSON representation

A suite of tools for adding sitemaps to Clay sites.

• Host: GitHub
• URL: https://github.com/nymag/clay-sitemaps
• Owner: nymag
• Created: 2017-02-16T16:33:57.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-03-17T21:19:17.000Z (almost 4 years ago)
• Last Synced: 2024-12-01T00:27:41.806Z (about 1 month ago)
• Language: JavaScript
• Size: 215 KB
• Stars: 2
• Watchers: 44
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# clay-sitemaps

A suite of tools for generating sitemaps for Clay sites.

Clay-sitemaps provides two "standard" sitemap middleware, one for text and one for XML, that can get you up and running quickly. It also provides utilities that can help you create your own sitemap logic.

## Quick Start

```

const sitemaps = require('clay-sitemaps')(someAmphoraInstance);

app.use(sitemaps.middleware());

```

This will create a textual sitemap at `/sitemap.txt` that includes URLs of published, public pages.

It will also create an XML sitemap at `/sitemap.xml` that includes published, public pages. Each page will appear as an `` element with a `` set to the page's `url` property. Additionally, the `sitemap` template of each component on that page will be rendered and included in that block.

### sitemaps.middleware(xmlOpts)

Generates standard "batteries included" middleware for clay sites, using `standardXML` and `standardText` routing functions. `xmlOpts` are passed to the former.

## Advanced usage

You can also use the functions behind clay-sitemaps to construct your own sitemap generation logic.

### Plug-and-play routing functions

#### sitemaps.standardXML(options)

Returns a routing function for displaying an XML sitemap. This XML sitemap includes published, public pages, and renders the `sitemap.xml` template of each component in each page.

Options include:

* **prelude**: String. String to prepend to the XML document before the first `` element. See `lib/constants.js` for default.

* **postlude**: String. String to prepend to the XML document after the last `` element. Default is ``

* **engines**: Object. Engines for rendering the sitemap templates. Default is `{handlebars: require('handlebars')}`.

#### sitemaps.standardText()

Returns a routing function for displaying an textual sitemap.

### Streaming functions

#### sitemaps.streamPages(prefix)

Creates an object stream of ALL pages in Amphora with `prefix`. These objects look like:

```

{

  pageRef: string,

  pageData: object

}

```

The `pageData` value is the page data **not** composed, i.e. it includes top-level component references but no component data.

### Filter Streams

Filters are functions that remove pages from the stream.

#### sitemaps.filters.publicFilter()

Returns a transform function that keeps only public pages from a pages stream.

#### sitemaps.filters.publishedFilter()

Returns a transform function that keeps only published pages from a pages stream.

### Transform Streams

Transforms are functions that modify a stream of pages or strings.

#### sitemaps.transforms.pages.toText()

Returns a transform function that converts a stream of pages to a stream of strings reflecting the URL of each page.

#### sitemaps.transforms.pages.toXML(locals, multiplex)

Returns a transform function that converts a stream of pages to a stream of XML including the URL of each page and rendered `sitemap` templates of all components on each page.

#### sitemaps.transforms.pages.compose(locals)

Returns a transform function that composes the `pageData` property in each item in a stream of pages so it includes all component data on that page.

#### sitemaps.transforms.strings.addBookends(prelude, postlude)

Returns a transform function that adds strings to the beginning and/or end of a stream of strings.