base on a Jekyll Plugin that generates a JSON file with data for all the Pages in your Site # Jekyll Pages API [](https://travis-ci.org/18F/jekyll_pages_api) [](https://codeclimate.com/github/18F/jekyll_pages_api) [](https://gitter.im/18F/jekyll_pages_api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) Jekyll Pages API is a [Jekyll Plugin](http://jekyllrb.com/docs/plugins/) gem that generates a JSON file with data for all the Pages, Posts, Documents (i.e. "collections") and StaticFiles in your Site. [Jekyll](http://jekyllrb.com), if you're not familiar, is a static website generator written in Ruby. ## Usage Add this line to your application's Gemfile: ```ruby group :jekyll_plugins do gem 'jekyll_pages_api' end ``` If you're creating a new Gemfile in your Jekyll project, make sure to include a source at the top: ```ruby source 'https://rubygems.org' ``` And then execute: ```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 like this: ```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...", "meta": { // all the frontmatter for the page "title": "18F Hub", "url": "/", "layout": "page", "permalink": "/", } }, // ... ] } ``` This endpoint will be re-generated any time your site is rebuilt. ### Skipping the index The [Jekyll Pages API Search plugin](https://github.com/18F/jekyll_pages_api_search) uses this plugin to build a search index. Add `skip_index: true` to the front matter of any documents you wish to exclude from this index. ### Running standalone If you wish to generate a `pages.json` file when using a site generation tool other than Jekyll, you can run the `jekyll_pages_api` executable as a post-generation step. Run `jekyll_pages_api -h` for instructions. ## Developing > __Important Note:__ This gem uses the [Appraisal Gem](https://github.com/thoughtbot/appraisal) to ensure that it's tests pass against all supported versions of Jekyll. It uses the `appraisal` command - you can read more [in the documentation](https://github.com/thoughtbot/appraisal#usage). * Run `bundle` to install any necessary gems. * Run `bundle exec rake -T` to get a list of build commands and descriptions. * Run `bundle exec rake spec` to run the tests. * Run `appraisal install` to install the correct Jekyll dependencies. * Run `appraisal rake spec` to run all of the appraisals. * Run `bundle exec rake build` to ensure the entire gem can build. * Commit an update to bump the version number of `lib/jekyll_pages_api/version.rb` before running `bundle exec rake release`. While developing this gem, add this to the Gemfile of any project using the gem to try out your changes (presuming the project's working directory is a sibling of the gem's working directory): ```ruby group :jekyll_plugins do gem 'jekyll_pages_api', :path => '../jekyll_pages_api' end ``` ## 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 ", Assign "at most 3 tags" to the expected json: {"id":"13071","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"