| 1 | # hexo-generator-sitemap
|
| 2 |
|
| 3 | [](https://travis-ci.org/hexojs/hexo-generator-sitemap)
|
| 4 | [](https://www.npmjs.com/package/hexo-generator-sitemap)
|
| 5 | [](https://coveralls.io/r/hexojs/hexo-generator-sitemap?branch=master)
|
| 6 |
|
| 7 | Generate sitemap.
|
| 8 |
|
| 9 | ## Install
|
| 10 |
|
| 11 | ``` bash
|
| 12 | $ npm install hexo-generator-sitemap --save
|
| 13 | ```
|
| 14 |
|
| 15 | - Hexo 4: 2.x
|
| 16 | - Hexo 3: 1.x
|
| 17 | - Hexo 2: 0.x
|
| 18 |
|
| 19 | ## Options
|
| 20 |
|
| 21 | You can configure this plugin in `_config.yml`.
|
| 22 |
|
| 23 | ``` yaml
|
| 24 | sitemap:
|
| 25 | path: sitemap.xml
|
| 26 | template: ./sitemap_template.xml
|
| 27 | rel: false
|
| 28 | ```
|
| 29 |
|
| 30 | - **path** - Sitemap path. (Default: sitemap.xml)
|
| 31 | - **template** - Custom template path. This file will be used to generate sitemap.xml (See [default template](/sitemap.xml))
|
| 32 | - **rel** - Add [`rel-sitemap`](http://microformats.org/wiki/rel-sitemap) to the site's header. (Default: `false`)
|
| 33 |
|
| 34 | ## Excluding Posts
|
| 35 |
|
| 36 | Add `sitemap: false` to the post's front matter.
|