jekyll_pocket

jekyll hook plugin for building a fully portable site 🎣💾👝

Gem Version License PRs Welcome Build Status

Installation

Add this line to your application's Gemfile:

gem 'jekyll_pocket'

Then execute:

$ bundle

And add it as a jekyll plugin in your _config.yml file

plugins:
    - jekyll_pocket

Usage

Make sure all of your files are using file extensions by setting permalink: none in your _config.yml file and looking through any custom page-level permalinks.

Then run jekyll build in pocket mode with:

$ bundle exec jekyll build JEKYLL_ENV=pocket

When the build is finished, you should be able to double click on your compiled index.html page and open up a fully functioning, serverless site in your browser. The links are all relative so you can move the site onto a thumbdrive and share it offline however you like.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the JekyllPocket project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.