https://github.com/hexojs/hexo-generator-sitemap
Sitemap generator for Hexo.
https://github.com/hexojs/hexo-generator-sitemap
hexo hexo-plugin
Last synced: 12 months ago
JSON representation
Sitemap generator for Hexo.
- Host: GitHub
- URL: https://github.com/hexojs/hexo-generator-sitemap
- Owner: hexojs
- License: mit
- Created: 2014-01-11T13:38:28.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T04:50:05.000Z (almost 2 years ago)
- Last Synced: 2025-07-05T07:11:39.405Z (12 months ago)
- Topics: hexo, hexo-plugin
- Language: JavaScript
- Homepage: https://hexo.io
- Size: 204 KB
- Stars: 322
- Watchers: 14
- Forks: 52
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hexo-generator-sitemap
[](https://github.com/hexojs/hexo-generator-sitemap/actions?query=workflow%3ATester)
[](https://www.npmjs.com/package/hexo-generator-sitemap)
[](https://coveralls.io/r/hexojs/hexo-generator-sitemap?branch=master)
Generate sitemap.
## Install
``` bash
$ npm install hexo-generator-sitemap --save
```
- Hexo 4: 2.x
- Hexo 3: 1.x
- Hexo 2: 0.x
## Options
You can configure this plugin in `_config.yml`.
``` yaml
sitemap:
path:
- sitemap.xml
- sitemap.txt
template: ./sitemap_template.xml
template_txt: ./sitemap_template.txt
rel: false
tags: true
categories: true
```
- **path** - Sitemap path. (Default: sitemap.xml)
- **template** - Custom template path. This file will be used to generate sitemap.xml (See [default xml template](/sitemap.xml))
- **template_txt** - Custom template path. This file will be used to generate sitemap.txt (See [default txt template](/sitemap.txt))
- **rel** - Add [`rel-sitemap`](http://microformats.org/wiki/rel-sitemap) to the site's header. (Default: `false`)
- **tags** - Add site's tags
- **categories** - Add site's categories
## Exclude Posts/Pages
Add `sitemap: false` to the post/page's front matter.
``` yml
---
title: lorem ipsum
date: 2020-01-02
sitemap: false
---
```