Skip to content

Commit

Permalink
updating docs and rebuilding with verb
Browse files Browse the repository at this point in the history
  • Loading branch information
@doowb
doowb committed Sep 25, 2015
1 parent 71ef567 commit b17b43a
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 972 deletions.
27 changes: 14 additions & 13 deletions .verb.md
View file
@@ -1,23 +1,23 @@
# {%= name %} {%= badge('fury') %} {% if (travis) { %} {%= badge('travis') %}{% } %}
# {%= name %} {%= badge('fury') %} {%= badge('travis') %}

> {%= description %}
## Table of Contents
{%= toc() %}
<!-- toc -->

{%= include("install", {save: '--save'}) %}

Next, register the middleware with Assemble:
Next, register the plugin with Assemble:

```js
assemble: {
options: {
middleware: ['{%= name %}', 'other/middleware/*']
plugins: ['{%= name %}', 'other/plugins/*']
}
}
```

Visit the [middleware docs](http://assemble.io/middleware/) for more info or for help getting started.
Visit the [plugins docs](http://assemble.io/plugins/) for more info or for help getting started.

## Options
{%= docs("options") %}
Expand All @@ -28,21 +28,22 @@ Visit the [middleware docs](http://assemble.io/middleware/) for more info or for
## Contributing
We welcome all kinds of contributions! The most basic way to show your support is to star the project, and if you'd like to get involved please see the [Contributing to {%= name %}](http://assemble.io/contributing/) guide for information on contributing to this project.

## Changes
{%= changelog() %}
***

## Other grunt-assemble plugins
{%= related(verb.related.list, {remove: name}) %}


***

## Author
{%= contrib("hariadi") %}
{%= include("author") %}

## License
{%= copyright() %}
{%= license() %}

***

## Related projects
{%= include("assemble/repos-list") %}

***

{%= include('footer.md') %}
{%= include('footer.md') %}
167 changes: 78 additions & 89 deletions README.md
View file
@@ -1,74 +1,86 @@
# assemble-middleware-sitemap [![NPM version](https://badge.fury.io/js/assemble-middleware-sitemap.png)](http://badge.fury.io/js/assemble-middleware-sitemap) [![Build Status](https://travis-ci.org/assemble/assemble-middleware-sitemap.png)](https://travis-ci.org/assemble/assemble-middleware-sitemap)
# grunt-assemble-sitemap [![NPM version](https://badge.fury.io/js/grunt-assemble-sitemap.svg)](http://badge.fury.io/js/grunt-assemble-sitemap) [![Build Status](https://travis-ci.org/assemble/grunt-assemble-sitemap.svg)](https://travis-ci.org/assemble/grunt-assemble-sitemap)

> Sitemap middleware for Assemble
> Sitemap plugin for Assemble
## Table of Contents
* [Install](#install)

<!-- toc -->

* [Options](#options)
* [Usage Examples](#usage-examples)
* [Contributing](#contributing)
* [Changes](#changes)
* [Other grunt-assemble plugins](#other-grunt-assemble-plugins)
* [Author](#author)
* [License](#license)
* [Related projects](#related-projects)

_(Table of contents generated by [verb])_

## Install
Install with [npm](npmjs.org):
<!-- tocstop -->

```bash
npm i assemble-middleware-sitemap --save-dev
```sh
$ npm i grunt-assemble-sitemap --save
```

Next, register the middleware with Assemble:
Next, register the plugin with Assemble:

```js
assemble: {
options: {
middleware: ['assemble-middleware-sitemap', 'other/middleware/*']
plugins: ['grunt-assemble-sitemap', 'other/plugins/*']
}
}
```

Visit the [middleware docs](http://assemble.io/middleware/) for more info or for help getting started.
Visit the [plugins docs](http://assemble.io/plugins/) for more info or for help getting started.

## Options

See [sitemaps.org](http://www.sitemaps.org/protocol.html#xmlTagDefinitions) for detail XML tag definitions.

### dest
Type: `String`
## dest

Type: `String`

Default: `undefined`

Sitemap destination. If not set, fallback to assemble destination.

### homepage
Type: `String`
## homepage

Type: `String`

Default: `homepage` (from package.json)

Site URL

### changefreq
Type: `String`
## changefreq

Type: `String`

Default: `weekly`

How frequently the page is likely to change. This value provides general information to search engines and may not correlate exactly to how often they crawl the page. Valid values are:

- always
- hourly
- daily
- weekly
- monthly
- yearly
- never
* always
* hourly
* daily
* weekly
* monthly
* yearly
* never

## priority

Type: `Float`

### priority
Type: `Float`
Default: `0.5`

The priority of this URL relative to other URLs on your site. Valid values range from 0.0 to 1.0. This value does not affect how your pages are compared to pages on other sites—it only lets the search engines know which pages you deem most important for the crawlers.

### exclusions
Type: `Array`
## exclusions

Type: `Array`

Default: `['404']`

Pages to omit from the sitemap.
Expand All @@ -84,52 +96,55 @@ options: {
}
```

### relativedest
Type: `String` / `Boolean`
## relativedest

Type: `String` / `Boolean`

Default: `false`

Path to which the URLs in Sitemap and Robots should be relative to. `true` is equal to the destination path `dest` and `false` is equal to the root directory.

### robot
Type: `Boolean`
## robot

Type: `Boolean`

Default: `true`

Generate robots.txt from `exclusions` list.


## Usage Examples
### Simple

## Simple

To simplify might do something like:

```js
assemble: {
blog: {
options: {
plugins: ['assemble-middleware-sitemap'],
plugins: ['grunt-assemble-sitemap'],
},
files: {
'./blog/': ['./templates/blog/*.hbs']
}
}
}

```

### Result
## Result

```js
./blog/sitemap.xml
./blog/robots.txt
```

### Advanced
## Advanced

```js
assemble: {
blog: {
options: {
plugins: ['assemble-middleware-sitemap'],
plugins: ['grunt-assemble-sitemap'],
sitemap: {
homepage: 'http://assemble.io',
changefreq: 'daily',
Expand All @@ -145,71 +160,45 @@ assemble: {
}
```

### Result
## Result

```js
./blog/sitemap.xml
```


## Contributing
We welcome all kinds of contributions! The most basic way to show your support is to star the project, and if you'd like to get involved please see the [Contributing to assemble-middleware-sitemap](http://assemble.io/contributing/) guide for information on contributing to this project.

## Changes
**DATE** **VERSION** **CHANGES**
* 2014-06-01 v0.2.5 fix sitemap and robots not generated,relativedest can be a path now
* 2014-06-01 v0.2.4 added sitemap URL to robots.txt,added relativedest to options
* 2014-05-03 v0.2.3 fixes toc,Change docs to use verb
* 2014-03-26 v0.2.2 Change from plugin to middleware
* 2014-02-21 v0.2.1 fix option.robot was ignored and always true 0159123,(feat) add option.dest
and use as output path,fix option.robot was ignored and always true,(feat)
add option to overwrite changefreq per file,cosmetical changes (code
formatting, naming, simplify),(wip) enable globbing patterns for
option.exclude
* 2014-02-05 v0.2.0 Generation of robots.txt will now respect the relativedest option.
* 2014-02-02 v0.1.9 Fix sitemap destination
* 2014-01-28 v0.1.8 Use external library,Get pages from assemble object
* 2014-01-03 v0.1.7 Add relativedest option
* 2013-12-12 v0.1.6 Fix plugin name in Usage Examples,Update deps
* 2013-11-28 v0.1.4 Updates dependencies to work with Grunt 0.4.2,[object Object],Add TOC to
docs
* 2013-10-20 v0.1.3 Fix sitemap and robots.txt generated on every folder,Update docs
options:exclusions
* 2013-10-18 v0.1.2 Fix homepage
* 2013-10-17 v0.1.1 Add option to generate robots.txt,Change name to
assemble-contrib.sitemap,Move to Assemble main repo
* 2013-10-01 v0.1.0 First commmit.,Add option to exclude

## Author
We welcome all kinds of contributions! The most basic way to show your support is to star the project, and if you'd like to get involved please see the [Contributing to grunt-assemble-sitemap](http://assemble.io/contributing/) guide for information on contributing to this project.

**Hariadi Hinta**
***

+ [github.com/hariadi](https://github.com/hariadi)
+ [twitter.com/hariadi](http://twitter.com/hariadi)
## Other grunt-assemble plugins

## License
Copyright (c) 2014 Hariadi Hinta, contributors.
Released under the MIT license
* [grunt-assemble](https://www.npmjs.com/package/grunt-assemble): Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… [more](https://www.npmjs.com/package/grunt-assemble) | [homepage](http://assemble.io)
* [grunt-assemble-anchors](https://www.npmjs.com/package/grunt-assemble-anchors): Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js. | [homepage](https://github.com/assemble/grunt-assemble-anchors)
* [grunt-assemble-contextual](https://www.npmjs.com/package/grunt-assemble-contextual): Generates a JSON file with the context of each page. Basic plugin to help see… [more](https://www.npmjs.com/package/grunt-assemble-contextual) | [homepage](https://github.com/assemble/grunt-assemble-contextual)
* [grunt-assemble-decompress](https://www.npmjs.com/package/grunt-assemble-decompress): Assemble plugin for extracting zip, tar and tar.gz archives. | [homepage](https://github.com/assemble/grunt-assemble-decompress)
* [grunt-assemble-download](https://www.npmjs.com/package/grunt-assemble-download): Assemble plugin for downloading files from GitHub. | [homepage](https://github.com/assemble/grunt-assemble-download)
* [grunt-assemble-i18n](https://www.npmjs.com/package/grunt-assemble-i18n): Plugin for adding i18n support to Assemble projects. | [homepage](https://github.com/assemble/grunt-assemble-i18n)
* [grunt-assemble-lunr](https://www.npmjs.com/package/grunt-assemble-lunr): Assemble plugin for adding search capabilities to your static site, with lunr.js. | [homepage](http://assemble.io)
* [grunt-assemble-navigation](https://www.npmjs.com/package/grunt-assemble-navigation): Assemble navigation plugin. Automatically generate Bootstrap-style, multi-level side nav. See the sidenav on assemble.io for… [more](https://www.npmjs.com/package/grunt-assemble-navigation) | [homepage](https://github.com/assemble/grunt-assemble-navigation)
* [grunt-assemble-permalinks](https://www.npmjs.com/package/grunt-assemble-permalinks): Permalinks plugin for Assemble, the static site generator for Grunt.js, Yeoman and Node.js. This plugin… [more](https://www.npmjs.com/package/grunt-assemble-permalinks) | [homepage](https://github.com/assemble/grunt-assemble-permalinks)
* [grunt-assemble-wordcount](https://www.npmjs.com/package/grunt-assemble-wordcount): Assemble plugin for displaying wordcount and average reading time to blog posts or pages. | [homepage](https://github.com/assemble/grunt-assemble-wordcount)

***

## Related projects
Here are some related projects you might be interested in from the [Assemble](http://assemble.io) core team.
## Author

+ [assemble-middleware-anchors](https://github.com/assemble/assemble-middleware-anchors): Assemble middleware for creating anchor tags from generated html.
+ [assemble-middleware-contextual](https://github.com/assemble/assemble-middleware-contextual): Assemble middleware for generating a JSON file containing the context of each page. Basic middleware to help see what's happening in the build.
+ [assemble-middleware-decompress](https://github.com/assemble/assemble-middleware-decompress): Assemble plugin for extracting zip, tar and tar.gz archives.
+ [assemble-middleware-download](https://github.com/assemble/assemble-middleware-download): Assemble middleware for downloading files from GitHub.
+ [assemble-middleware-i18n](https://github.com/assemble/assemble-middleware-i18n): Assemble middleware for adding i18n support to projects.
+ [assemble-middleware-lunr](https://github.com/assemble/assemble-middleware-lunr): Assemble middleware for creating a search engine within your static site using lunr.js.
+ [assemble-middleware-permalinks](https://github.com/assemble/assemble-middleware-permalinks): Permalinks middleware for Assemble, the static site generator for Grunt.js and Yeoman. This plugin enables powerful and configurable URI replacement patterns, presets, uses Moment.js for parsing dates, and much more.
+ [assemble-middleware-rss](https://github.com/assemble/assemble-middleware-rss): Assemble middleware for creating RSS feeds with Assemble. (NOT published yet!)
+ [assemble-middleware-toc](https://github.com/assemble/assemble-middleware-toc): Assemble middleware for creating a table of contents in the generated HTML, using Cheerio.js
+ [assemble-middleware-wordcount](https://github.com/assemble/assemble-middleware-wordcount): Assemble middleware for displaying a word-count, and estimated reading time on blog posts or pages.
**Hariadi Hinta**

+ [github/hariadi](https://github.com/hariadi)
+ [twitter/hariadi](http://twitter.com/hariadi)

Visit [assemble.io/assemble-middleware](http:/assemble.io/assemble-middleware/) for more information about [Assemble](http:/assemble.io/) middleware.
## License

Copyright © 2015 Hariadi Hinta
Released under the MIT license.

***

_This file was generated by [grunt-verb](https://github.com/assemble/grunt-verb) on June 03, 2014._
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 25, 2015._

0 comments on commit b17b43a

Please sign in to comment.