valadocbr-theme

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 and your sass in _sass. 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

Add this line to your Jekyll site's Gemfile:

gem "valadocbr-theme"

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

theme: valadocbr-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install valadocbr-theme

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

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

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.

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