Ecosyste.ms: Awesome

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

https://github.com/syntax-tree/xast-util-sitemap

xast utility to build a sitemap
https://github.com/syntax-tree/xast-util-sitemap

sitemap xast xast-util xml

Last synced: 8 days ago
JSON representation

xast utility to build a sitemap

Lists

README 

        
# xast-util-sitemap



[![Build][build-badge]][build]

[![Coverage][coverage-badge]][coverage]

[![Downloads][downloads-badge]][downloads]

[![Size][size-badge]][size]

[![Sponsors][sponsors-badge]][collective]

[![Backers][backers-badge]][collective]

[![Chat][chat-badge]][chat]



[xast][] utility to build a [`sitemap.xml`][sitemap-site].



## Contents



*   [What is this?](#what-is-this)

*   [When should I use this?](#when-should-i-use-this)

*   [Install](#install)

*   [Use](#use)

*   [API](#api)

    *   [`sitemap(data)`](#sitemapdata)

    *   [`Entry`](#entry)

    *   [`Alternate`](#alternate-1)

*   [Types](#types)

*   [Compatibility](#compatibility)

*   [Security](#security)

*   [Related](#related)

*   [Contribute](#contribute)

*   [License](#license)



## What is this?



This package helps you build a [`sitemap.xml`][sitemap-site].

It supports localization as suggested by [Google][].



## When should I use this?



This package focusses on a small set of widely used parts of sitemaps.

It has a few good options instead of overwhelming with everything that *could*

be done.

If you do need more things, well: this utility gives you a syntax tree, which

you can change.



This proejct is intended for sites with up to 50k URLs and a resulting

serialized contents of up to 50MB.

Wrapping this project into something that generates sitemap index files is left

as an exercise to the reader.



You don’t always need a sitemap.

[See Google’s recommendations for whether you need a

sitemap](https://developers.google.com/search/docs/advanced/sitemaps/overview)



You should place sitemaps in the root of your site and reference them in

`robots.txt`.

You might also [report](https://support.google.com/webmasters/answer/7451001)

sitemap changes to Google.



## Install



This package is [ESM only][esm].

In Node.js (version 16+), install with [npm][]:



```sh

npm install xast-util-sitemap

```



In Deno with [`esm.sh`][esmsh]:



```js

import {sitemap} from 'https://esm.sh/xast-util-sitemap@2'

```



In browsers with [`esm.sh`][esmsh]:



```html



  import {sitemap} from 'https://esm.sh/xast-util-sitemap@2?bundle'



```



## Use



```js

import {sitemap} from 'xast-util-sitemap'

import {toXml} from 'xast-util-to-xml'



const tree = sitemap([

  'https://example.com/alpha/',

  {url: 'https://example.com/bravo/'},

  {url: 'https://example.com/charlie/', modified: new Date(2018, 1, 2, 3)},

  {

    url: 'https://example.com/delta/',

    lang: 'en',

    alternate: {

      nl: 'https://example.com/dirk/',

      'fr-BE': 'https://example.com/désiré/'

    }

  }

])



console.log(toXml(tree))

```



Yields (pretty printed):



```xml



  

    https://example.com/alpha/

  

  

    https://example.com/bravo/

  

  

    https://example.com/charlie/

    2018-02-02T02:00:00.000Z

  

  

    https://example.com/delta/

    

    

    

  

  

    https://example.com/dirk/

    

    

    

  

  

    https://example.com/d%C3%A9sir%C3%A9/

    

    

    

  



```



## API



This package exports the identifier [`sitemap`][api-sitemap].

There is no default export.



### `sitemap(data)`



Build a sitemap.



###### Parameters



*   `data` (`Array`)

    — entries to build a sitemap for

    (see [`Entry`][api-entry], strings are equivalent to `{url: string}`)



###### Returns



Sitemap ([`Root`][root]).



### `Entry`



Entries represent a single URL and describe them with metadata (TypeScript

type).



##### Fields



###### `url`



Full URL ([``][loc]; `string`, required, example: `https://example.org/`).



###### `modified`



Value indicating when the page last changed ([``][lastmod]; `Date` or

value for `new Date(x)`, optional).



###### `lang`



[BCP 47][bcp47] tag indicating the language of the page (`string`, required w/

`alternate`, example: `'en-GB'`).



###### `alternate`



Translations of the page, where each key is a [BCP 47][bcp47] tag and each

value an [`Alternate`][api-alternate] (`Record`, optional,

example: `{nl: 'https://example.nl/'}`).



Alternate resources “inherit” fields (`modified`) from the entry they are

described in.



### `Alternate`



Alternative content, typically a translation (TypeScript type).



To define different fields, either use a full entry object:



```js

[

  {

    url: 'https://example.com/delta/',

    modified: '05 October 2011 14:48 UTC',

    lang: 'en',

    alternate: {nl: {url: 'https://example.com/dirk/', modified: '20 January 2020 00:00 UTC'}}

  }

]

```



…or define them separately:



```js

[

  {

    url: 'https://example.com/delta/',

    modified: '05 October 2011 14:48 UTC',

    lang: 'en',

    alternate: {nl: 'https://example.com/dirk/'}

  },

  {

    url: 'https://example.com/dirk/',

    modified: '20 January 2020 00:00 UTC',

    // `xast-util-sitemap` is smart enough to know about the next two already,

    // but they’re shown here for clarity.

    lang: 'nl',

    alternate: {en: 'https://example.com/delta/'}

  }

]

```



###### Type



```ts

type Alternate = Omit | string

```



## Types



This package is fully typed with [TypeScript][].

It exports the additional types [`Alternate`][api-alternate] and

[`Entry`][api-entry].



## Compatibility



Projects maintained by the unified collective are compatible with maintained

versions of Node.js.



When we cut a new major release, we drop support for unmaintained versions of

Node.

This means we try to keep the current release line, `xast-util-sitemap@^2`,

compatible with Node.js 16.



## Security



XML can be a dangerous language: don’t trust user-provided data.

Sitemaps also indicate “ownership” of URLs: crawlers assume that the origin

of the `sitemap.xml` file is also an owner



## Related



*   [`xast-util-to-xml`](https://github.com/syntax-tree/xast-util-to-xml)

    — serialize xast to XML

*   [`xast-util-feed`](https://github.com/syntax-tree/xast-util-feed)

    — build feeds (RSS, Atom)

*   [`xastscript`](https://github.com/syntax-tree/xastscript)

    — create xast trees



## Contribute



See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for

ways to get started.

See [`support.md`][support] for ways to get help.



This project has a [code of conduct][coc].

By interacting with this repository, organization, or community you agree to

abide by its terms.



## License



[MIT][license] © [Titus Wormer][author]



[build-badge]: https://github.com/syntax-tree/xast-util-sitemap/workflows/main/badge.svg



[build]: https://github.com/syntax-tree/xast-util-sitemap/actions



[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/xast-util-sitemap.svg



[coverage]: https://codecov.io/github/syntax-tree/xast-util-sitemap



[downloads-badge]: https://img.shields.io/npm/dm/xast-util-sitemap.svg



[downloads]: https://www.npmjs.com/package/xast-util-sitemap



[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=xast-util-sitemap



[size]: https://bundlejs.com/?q=xast-util-sitemap



[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg



[backers-badge]: https://opencollective.com/unified/backers/badge.svg



[collective]: https://opencollective.com/unified



[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg



[chat]: https://github.com/syntax-tree/unist/discussions



[npm]: https://docs.npmjs.com/cli/install



[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c



[esmsh]: https://esm.sh



[typescript]: https://www.typescriptlang.org



[license]: license



[author]: https://wooorm.com



[health]: https://github.com/syntax-tree/.github



[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md



[support]: https://github.com/syntax-tree/.github/blob/main/support.md



[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md



[xast]: https://github.com/syntax-tree/xast



[root]: https://github.com/syntax-tree/xast#root



[sitemap-site]: https://www.sitemaps.org



[loc]: https://www.sitemaps.org/protocol.html#locdef



[lastmod]: https://www.sitemaps.org/protocol.html#lastmoddef



[bcp47]: https://github.com/wooorm/bcp-47



[google]: https://developers.google.com/search/docs/advanced/crawling/localized-versions#expandable-3



[api-sitemap]: #sitemapdata



[api-entry]: #entry



[api-alternate]: #alternate-1