README.md in middleman-search_engine_sitemap-1.0.1 vs README.md in middleman-search_engine_sitemap-1.1.0.pre
- old
+ new
@@ -1,10 +1,12 @@
# Middleman Search Engine Sitemap
[](https://travis-ci.org/Aupajo/middleman-search_engine_sitemap)
[](https://codeclimate.com/github/Aupajo/middleman-search_engine_sitemap)
[](https://gemnasium.com/Aupajo/middleman-search_engine_sitemap)
+[](http://badge.fury.io/rb/middleman-search_engine_sitemap)
[Sitemaps](http://www.sitemaps.org/) are an open standard to tell search engines (such as Google) about each page on your site, how often they're updated, and how important each page is, relative to other pages on your site.
This project aims to simplify including the sitemap XML file along with your Middleman site, so that you can better instruct search engines on how to index your pages.
@@ -35,9 +37,30 @@
activate :search_engine_sitemap
```
The sitemap will become available at [http://localhost:4567/sitemap.xml](http://localhost:4567/sitemap.xml).
+
+## Excluding pages
+
+You can add a `hide_from_sitemap` attribute to your page's frontmatter to omit it from the sitemap:
+
+```erb
+---
+title: My hidden page
+hide_from_sitemap: true
+---
+
+Shh. Don't tell anyone I'm here.
+```
+
+If you would like to use a different frontmatter attribute, you can specify it in the extension options:
+
+```ruby
+activate :search_engine_sitemap, exclude_attr: 'hidden'
+```
+
+You would then be able to use `hidden: true` in place of `hide_from_sitemap: true`.
### Settings
Pages have a priority of 0.5 and a change frequency of `monthly` by default.