monospace-web-jekyll-theme

A minimal Jekyll theme that automatically vendors CSS/JS from monospace-web-theme. Published as a RubyGem.

Add this line to your Jekyll site's Gemfile:

gem "monospace-web-jekyll-theme"

And add this line to your Jekyll site's _config.yml:

theme: monospace-web-jekyll-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install monospace-web-jekyll-theme

TODO: Write usage instructions here. Describe your available layouts, includes and/or assets.

# In the *site* that consumes your theme
theme: monospace-web-jekyll-theme

theme_options:
  show_theme_box: false # turn off the info box

By default, Pages won’t copy your theme’s vendored CSS/JS into the published site, so to get all colour flavours working (e.g. data-theme="rose"), use the built-in remote_theme support:

1. Install the remote-theme plugin
   In your Gemfile:

   group :jekyll_plugins do
     gem "jekyll-feed", "~> 0.12"
     gem "jekyll-remote-theme"
   end

   Then run:

   bundle install

2. Configure

   In your _config.yml:

   remote_theme: CameronBrooks11/monospace-web-jekyll-theme
   plugins:
     - jekyll-feed
     - jekyll-remote-theme
   
   theme_options:
     default_theme: rose
     show_theme_box: true

3. Omit or remove the gem "monospace-web-jekyll-theme" line (your theme will now be pulled directly from GitHub).

Bug reports and pull requests are welcome on GitHub at https://github.com/CameronBrooks11/monospace-web-jekyll-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

To set up your environment to develop this theme, run bundle install.

To fetch the monospace-web-theme from npm, run npm install. Next run: npm ci to install exactly the versions from package-lock.json for a clean, reproducible build; then run: npm run vendor to copy the .min.css and .min.js files from node_modules/monospace-web-theme into your assets/css and assets/js directories.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in monospace-web-jekyll-theme.gemspec accordingly.

Run:

gem build monospace-web-jekyll-theme.gemspec

then:

gem push monospace-web-jekyll-theme-x.y.z.gem

where x.y.z should be replaced by the corresponding version number.

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