jekkyl-arumai

jekkyl-arumai

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in _layouts, your includes in _includes, your sass files in _sass and any other assets in assets.

To experiment with this code, add some sample content and run bundle exec jekyll serve – this directory is setup just like a Jekyll site!

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-arumai"

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

theme: jekyll-arumai

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-arumai

UI Customization

Changing the Prisma Theme

To change the Prisma theme, add the following line to your config.yml file:

prisma:
  theme_name: twilight

This line will replace the default Prisma theme with the specified one. You can visit the Prisma website for available theme names. Currently supported themes include: twilight, dark, funky, okaidia, coy, solarizedlight, and tomorrow.

Replacing the Default Home Page Image

To replace the default home page image, add the following page variables to your index.md file. Here is a sample code:

---
layout: home
image_url: "https://images.pexels.com/photos/2659939/pexels-photo-2659939.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2"
---

This markdown format will correctly set a new image for your home page.

Usage

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

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/blog-lab. 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.

Development

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

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, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in blog-lab.gemspec accordingly.

License

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