https://github.com/eng618/jekyll-theme-material
A jekyll theme based on material design light.
https://github.com/eng618/jekyll-theme-material
jekyll-site jekyll-theme-material jekyll-themes material mdl theme
Last synced: about 1 year ago
JSON representation
A jekyll theme based on material design light.
- Host: GitHub
- URL: https://github.com/eng618/jekyll-theme-material
- Owner: eng618
- License: mit
- Created: 2017-06-13T20:13:06.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-20T15:05:51.000Z (almost 9 years ago)
- Last Synced: 2025-02-14T04:49:57.163Z (over 1 year ago)
- Topics: jekyll-site, jekyll-theme-material, jekyll-themes, material, mdl, theme
- Language: HTML
- Size: 1.05 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jekyll-theme-material
This theme is based on Material Design Lite (MDL)
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-theme-material"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-theme-material
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-theme-material
## Usage
### Customization
You may choose to customize your sites default colors by defining the below two variables defined in the `_config.yml`:
```yml
color_primary:
color_accent:
```
**Note:** These colors must be one of the supported colors defined by MDL, which can be found here
### Configuration variables
Material will respect the following variables, if set in your site's `_config.yml`:
```yml
title: [The title of your site]
description: [A short description of your site's purpose]
```
Additionally, you may choose to set the following optional variables:
```yml
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
google_analytics: [Your Google Analytics tracking ID]
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ENG618/jekyll-theme-material. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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`, and `_sass` tracked with Git will be released.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).