zddhub/gravid

A simple and beautiful Jekyll theme.

gravid

Welcome to your new Jekyll theme - gravid!

Being talented just like being gravid, must be known with a long time past. I think I need more time to be talented, so I choose an easy one and named 'gravid'. 😊

Theme preview

Usage

Create a new Jekyll site:

jekyll new your-blog-name

Add this line to your Jekyll site's Gemfile:

gem "gravid"

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

theme: gravid

And then execute:

$ bundle

Or install it yourself as:

$ gem install gravid

Copy default files to your site:

cp -r $(bundle show gravid)/*.{md,html,yml} .

Run bundle exec jekyll serve and open your browser at http://localhost:4000.

Development

Gravid has been scaffolded by the jekyll new-theme command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration.

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, and _sass tracked with Git will be released.

Contributing

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

Thanks

Inspiration from Sofish's personal blog, Thanks.

License

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

Contact

If you have any question, please email to me.