README.md in jekyll_pages_api-0.1.0 vs README.md in jekyll_pages_api-0.1.1
- old
+ new
@@ -1,6 +1,6 @@
-# Jekyll Pages API [](https://travis-ci.org/18F/jekyll_pages_api)
+# Jekyll Pages API [](https://travis-ci.org/18F/jekyll_pages_api) [](https://codeclimate.com/github/18F/jekyll_pages_api)
Jekyll Pages API is a [Jekyll Plugin](http://jekyllrb.com/docs/plugins/) gem that generates a JSON file with data for all the Pages in your Site. [Jekyll](http://jekyllrb.com), if you're not familiar, is a static website generator written in Ruby.
## Usage
@@ -17,21 +17,34 @@
```bash
bundle
bundle exec jekyll serve
```
-You can then see the generated JSON file at http://localhost:4000/api/v1/pages.json, which will look something like this:
+You can then see the generated JSON file at http://localhost:4000/api/v1/pages.json, which will look like this:
-```json
+```javascript
{
"entries": [
{
"title": "18F Hub",
+ // the page path
"url": "/",
+ // the content of the page, with the HTML tags stripped and the whitespace condensed
"body": "18F is a digital services team within GSA..."
},
- ...
+ // ...
]
}
```
-This endpoint will be re-generated any time your site it rebuilt.
+This endpoint will be re-generated any time your site is rebuilt.
+
+## See also
+
+Additional means of turning your site content into data:
+
+* [Jekyll's `jsonify` filter](http://jekyllrb.com/docs/templates/)
+* [jekyll-git_metadata](https://github.com/ivantsepp/jekyll-git_metadata)
+* [jekyll-rss](https://github.com/agelber/jekyll-rss)
+* [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap)
+* Reading the YAML frontmatter of the source files
+* Scraping the HTML pages themselves