Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

static-sitemap-cli

0.1.0 • Public • Published

static-sitemap-cli

Simple CLI to pre-generate XML sitemaps for static sites locally.

Built in 10 minutes. 😜

Install

npm i -g static-sitemap-cli

Usage

Syntax: static-sitemap-cli <BASEURL> <options>

At its simplest, just go to your dist folder and run:

static-sitemap-cli https://example.com > sitemap.xml

By default outputs to stdout. So that you can pipe it to do other stuff.

Arguments

Argument Description
BASEURL Base URL that is prefixed to all location entries. For example: https://example.com/

Options

Option Long Description
-h --help show CLI help
-v --version show CLI version
-r --root [default: .] root dir to start from
-m --match [default: .html] comma-separated list of extensions to match
-i --ignore [default: 404.html] comma-separated list of globs to ignore
-p --priority comma-separated glob/priority pair; eg: foo/*.html,0.1
-f --changefreq comma-separated glob/changefreq pair; eg: foo/*.html,daily
-n --no-clean disable clean URLs
-s --slash add trailing slash to all URLs

Clean URLs

Whether or not to include the .html extension. By default, something like:

https://example.com/foo/index.html becomes https://example.com/foo.

Pass -n option to disable this behavior.

Trailing Slashes

Control whether or not URLs should include trailing slashes. For example:

https://example.com/bar/index.html becomes https://example.com/bar/.

For obvious reasons, this cannot be used together with -n.

Examples

Create sitemap for dist/ folder

static-sitemap-cli https://example.com -r dist/ > dist/sitemap.xml

Note: Just put dist/ for that location, not dist/. or ./dist/**.

Ignore a bunch of files

static-sitemap-cli https://example.com -i 404.html,foo/*.html > sm.xml

Set priority of certain pages

By default, the optional <priority> label (protocol reference) is excluded, so every pages' default is 0.5. To change the relative priority (to 0.1) of certain pages:

static-sitemap-cli https://example.com -p **/privacy-policy/**,0.1 **/terms-of-service/**,0.1 > sm.xml

To-do

Add tests! 😅

Changelog

v0.1.0 - 2019-07-26:

  • Initial release.

Install

npm i [email protected]

Version

0.1.0

License

ISC

Unpacked Size

8.2 kB

Total Files

6

Last publish

Collaborators

  • avatar