Skip to content

IEEEMerced/ieeemerced-jekyll-theme

Repository files navigation

ieeemerced-jekyll-theme

Build

This is the Jekyll theme used on our website.

Usage

If your Jekyll site is being deployed using Github pages, simply add

remote_theme: IEEEMerced/ieeemerced-jekyll-theme

to your _config.yml, and the theme will be automatically applied.

Contributing

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

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

License

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

About

This repository contains the jekyll theme used on the IEEE at Merced website.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published