Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 1.94 KB

README.md

File metadata and controls

57 lines (34 loc) · 1.94 KB
Raw

Anatole Jekyll Theme

This theme is the porting from Hugo to Jekyll of Anatole.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-anatole"

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

theme: jekyll-theme-anatole

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-anatole

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/ale-depi/jekyll-theme-anatole. 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

In order to ensure a unique environment for developing the theme, the following steps can be applied:

  • docker compose create
  • docker start -ia anatole-container

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 jekyll-theme-anatole.gemspec accordingly.

License

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