middleman / middleman-sitemap-api

JSON API for Middleman Sitemap

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

middleman-sitemap-api

middleman-sitemap-api is an extension for the Middleman static site generator that adds a RESTful API to Middleman's Sitemap Resources.

Install

In an existing Middleman project: Add middleman-sitemap-api to your Gemfile

gem "middleman-sitemap-api"

Then open your config.rb and add:

# MUST BE LAST ACTIVATION IN CONFIG!!! 
activate :sitemap_api

!!!MUST BE ACTIVATED LAST!!!

Options

option :at, '/__api', 'Specify where the API should live'
option :build, true, 'Whether the API is built to static files'
option :source_file, false, 'Lookup resources by source file'
option :include_body, false, 'Include rendered body in output'
option :include_raw_body, false, 'Include raw body in output'
option :include_layout, false, 'Include layout in rendered body'
option :include_metadata, true, 'Include metadata in output'
option :paginate, false, 'Max resources per page'

Build Status

Gem Version Build Status

Community

The official community forum is available at:

http://forum.middlemanapp.com/

Bug Reports

GitHub Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems:

https://github.com/middleman/middleman-sitemap-api/issues

The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit Pull Requests containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.

Support Us

Support via Gittip

Support via Donation

About

JSON API for Middleman Sitemap


Languages

Language:Ruby 100.0%