# grunt-sitemaps

> A Grunt plugin to automate the creation of sitemaps

Latest version **0.1.1** (published 2014-11-15) · 0 weekly downloads

## Install

```sh
npm install grunt-sitemaps
pnpm add grunt-sitemaps
yarn add grunt-sitemaps
bun add grunt-sitemaps
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2014-11-15 |
| First published | 2014-11-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Christian Hager |
| Maintainers | chager |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-sitemaps
- Repository: https://github.com/christian-hager/grunt-sitemaps
- Issues: https://github.com/christian-hager/grunt-sitemaps/issues
- npm.io page: https://npm.io/package/grunt-sitemaps

## Recent versions

- 0.1.1 (latest) — 2014-11-15
- 0.1.0 — 2014-11-15

## README

# grunt-sitemaps

> A Grunt plugin to automate the creation of sitemaps

## Getting Started
This plugin requires Grunt `~0.4.5`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-sitemaps --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-sitemaps');
```

## The "sitemaps" task

### Overview
In your project's Gruntfile, add a section named `sitemaps` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
    sitemaps: {
      default:{
        options: {
          baseUrl: 'http://www.mysite.com/',
          contentRoot: 'content/'
        },
        files: [{
          expand: true, // Enable dynamic expansion
          cwd: 'content/',
          src: ['**/*.{php,html}', '!exclude/**'] // Actual patterns to match
        }]
      }
    },
});
```

### Options

#### options.baseUrl
Type: `String`
Default value: `undefined`

A string value containing the base url of your site, e.g. 'http://www.mysite.com/'.

#### options.contentRoot
Type: `String`
Default value: `'.'`

A string value that contains the folder to be indexed.

#### options.dest
Type: `String`
Default value: `'.'`

A string value that contains the destination folder the generated sitemap will be written to.

#### options.removeFileExtensions
Type: `Boolean`
Default value: `'false'`

Set this to true if you want the generator to remove file extensions in urls.

#### options.mapIndexFilesToFolders
Type: `Boolean`
Default value: `'true'`

Set this to false if you don't want the generator to replace index files with their corresponding folders.

### Usage Examples

#### Default Options
In this example, the default options are used to index all html pages in folder content and write the generated sitemap to dist/sitemap.xml.

```js
grunt.initConfig({
    sitemaps: {
      options: {
        baseUrl: 'http://www.mysite.com/',
        contentRoot: 'content/',
        dest: 'dist/'
      },
      files: [{
        expand: true,
        cwd: 'content/',
        src: '**/*.html'
      }]
    }
});
```

#### Custom Options
In this example, custom options are used to do index all html pages in folder content and write the generated sitemap to dist/sitemap.xml.

```js
grunt.initConfig({
  sitemaps: {
    options: {
      baseUrl: 'http://www.mysite.com/',
      contentRoot: 'content/',
      dest: 'dist/',
      removeFileExtensions:true,
      mapIndexFilesToFolders: false
    },
    files: [{
      expand: true,
      cwd: 'content/',
      src: ['**/*.{php,html}', '!exclude/**']
    }]
  },
});
```

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History

 * 2014-11-15   v0.1.0   Initial release.

---
_Source: https://npm.io/package/grunt-sitemaps · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._