Skip to content

Repository files navigation

Jekyll Material Theme

A Jekyll Theme based on Material Design using Materialize.

CircleCIGem VersionGem

Examples

Cookie Policy

If you use cookies on your site, or choose to use Google Analytics, you're able to notify visitors with this prompt. The Thanks! dialog message can be customised in your _config.yml file.

Tools and Experience Section

If you'd like to display some of your skills and experience, you can do so through using the section below.

Installation

Add this line to your Jekyll site's Gemfile:

gem"jekyll-material-theme"

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

theme: jekyll-material-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-material-theme

Usage

The _config.yml file has the following options.

Please ensure to copy this sample before serving up your site as some variables are required in order to make the site run correctly.

title: Your awesome titlename: Your Nameemail: your-email@example.comdescription: Write an awesome description for your new site here. You can edit this line in _config.yml. It will appear in your document head meta (for Google search results) and in your feed.xml site description.display_footer: inital #change this to 'none' if you want to hide the footer copyright texttheme: jekyll-material-themeparallax_image_one: assets/images/startup3.jpg # These are the images used for the parallax backgroundparallax_image_two: assets/images/startup3.jpg# Settings for the porfolio sectionportfolio_heading: Portfolioportfolio_type: cards #cards or carouselproject_one: "First Project"project_one_description: Describe your project!project_one_url: https://github.com/jameshamann/jekyll-material-themeproject_one_icon: location_on # these are from materiailize css, the full collection is here: http://materializecss.com/icons.htmlproject_two: Second Projectproject_two_description: Describe your project!project_two_url: https://github.com/jameshamann/jekyll-material-themeproject_two_icon: photo_cameraproject_three: Third Projectproject_three_description: Describe your project!project_three_url: https://github.com/jameshamann/jekyll-material-themeproject_three_icon: hotelproject_four: Fourth Projectproject_four_description: Describe your project!project_four_url: https://github.com/jameshamann/jekyll-material-themeproject_four_icon: restaurant# Skill icons from https://konpa.github.io/devicon/skills:
- name: amazonwebservices
- name: android
- name: angularjs
- name: apache
- name: appcelerator
- name: apple
- name: atom
- name: babel
- name: backbonejs
- name: bitbucket
- name: bootstrap
- name: bower
- name: c
- name: chrome
- name: codeigniter
- name: coffescript
- name: confluence
- name: cplusplus
- name: csharp
- name: css3
- name: cucumber
- name: d3js
- name: debian
- name: devicon
- name: django
- name: docker
- name: doctrine
- name: dot-net
- name: drupal
- name: erlang
- name: facebook
- name: firefox
- name: foundation
- name: gatling
- name: gimp
- name: git
- name: github
- name: gitlab
- name: go
- name: google
- name: gradle
- name: grunt
- name: gulp
- name: heroku
- name: html5
- name: ie10
- name: illustrator
- name: inkscape
- name: itellij
- name: java
- name: jasmine
- name: javascript
- name: laravel
- name: less
- name: linux
- name: meteor
- name: mocha
- name: mongodb
- name: moodle
- name: mysql
- name: nginx
- name: nodejs
- name: nodewebkit
- name: oracle
- name: photoshop
- name: php
- name: phpstorm
- name: protractor
- name: postgresql
- name: python
- name: pycharm
- name: rails
- name: react
- name: redhat
- name: redis
- name: ruby
- name: rubymine
- name: safari
- name: sass
- name: sequelize
- name: slack
- name: sourcetree
- name: ssh
- name: swift
- name: symfony
- name: tomcat
- name: travis
- name: trello
- name: twitter
- name: typescript
- name: ubuntu
- name: vim
- name: visualstudio
- name: vuejs
- name: webpack
- name: webstorm
- name: windows8
- name: wordpress
- name: yii
- name: zend
- name: ansibleuri: https://upload.wikimedia.org/wikipedia/fr/thumb/4/4b/Ansible_logo.png/220px-Ansible_logo.png # Add external icon, for internal icon use uri: /assets/my_icon.jpgicon_size: 50# font-size of icons in pxcolored: colored # Leave blank for black and white iconsproject_button: Githubgithub: https://github.com/jameshamann/jekyll-material-thememedium: https://medium.combaseurl: # If your site is located at /blog or /home, change it here, otherwise leave it emptyurl: http://localhost:4000/ # The URL of your site# Google tracking, if both are filled, tag manager will prevail. Set up GA through GTM in that casetag_manager_id: # This looks something like GTM-XXXXXXXgoogle_analytics_tracking_id: # This looks something like UA-000000000-0 Head over to https://analytics.google.com/ to setup.cookie_accept_message: Thanks! # The pop-up dialog that appears after accepting the cookie notice.syntax_highlighting: true # include the css for syntax highlighting# Build settingsmarkdown: kramdownpermalink: prettyplugins:
- jekyll-feed
- jekyll-assets
- jekyll-minifier

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jameshamann/jekyll-material-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 and further customise this theme, fork the repo and explore the _assets directory, which includes all the css, js and font folders. If you're adding a feature, please add some tests in the spec directory to ensure everything works as intended.

Contributors

License

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

About

A Jekyll Theme based on Material Design using Materialize.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages