https://github.com/ieeemerced/ieeemerced-jekyll-theme

This repository contains the jekyll theme used on the IEEE at Merced website.
https://github.com/ieeemerced/ieeemerced-jekyll-theme

jekyll jekyll-theme

Last synced: 1 day ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ieeemerced/ieeemerced-jekyll-theme
• Owner: IEEEMerced
• License: mit
• Created: 2022-12-28T12:51:54.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-05T09:42:39.000Z (almost 2 years ago)
• Last Synced: 2024-11-11T01:41:58.150Z (2 months ago)
• Topics: jekyll, jekyll-theme
• Language: HTML
• Homepage:
• Size: 2.19 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# ieeemerced-jekyll-theme

[![Build](https://github.com/IEEEMerced/ieeemerced-jekyll-theme/actions/workflows/build.yml/badge.svg)](https://github.com/IEEEMerced/ieeemerced-jekyll-theme/actions/workflows/build.yml)

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](https://www.contributor-covenant.org/) 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](https://opensource.org/licenses/MIT).