search

ptsurbeleu / jekyll-theme-chalk-site

:star: An example of Jekyll site using gem-based Chalk theme by Nielsen Ramon
MIT License
5 stars 0 forks source link
chalk jekyll jekyll-blog jekyll-ecosystem jekyll-site nielsenramon

readme

Understanding gem-based themes

With gem-based themes, some of the site's directories (such as the _assets, _layouts, _includes, and _sass directories) are stored in the theme's gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll's build process.

Prerequisites

If you haven't installed the following tools then go ahead and do so (make sure you have Homebrew installed):

brew install ruby
brew install npm

On windows, install Ruby and Node with the installers found here:

Usage

This site has been manually scaffolded and has only files/folders you need to get it up & running.

If you haven't cloned this repository yet then go ahead and clone it:

git clone https://github.com/ptsurbeleu/jekyll-theme-chalk-site.git

After cloning the repository, go to jekyll-theme-chalk-site folder and execute:

bundle install -j12

This installs all the necessary dependencies for this Jekyll site to work properly. Once this is done you should see in your terminal something like this:

...
Fetching jekyll-theme-chalk 0.1.1
Installing jekyll-theme-chalk 0.1.1
Bundle complete! 3 Gemfile dependencies, 40 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.

The last step is get Jekyll site up and running with the following command:

bundle exec jekyll serve

And you are done!

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ptsurbeleu/jekyll-theme-chalk. 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.