Skip to content

Latest commit

 

History

History
94 lines (72 loc) · 3.94 KB

README.md

File metadata and controls

94 lines (72 loc) · 3.94 KB
Raw

material-jekyll

Project material-jekyll is a Jekyll theme supporting Material Design for Bootstrap.

The theme is built on an Ruby gem using free version of MDB for jQuery for material design and Jekyll 3.8 plugin to generate the static files with some customisations.

Installation

  1. Install all the gem dependencies [ref: bundler].
  2. Start the server by running 
    bundle exec jekyll serve --host=0.0.0.0
    and open http://0.0.0.0:4000/ in the browser to see the changes.

Add this line to your application's Gemfile:

gem 'material-jekyll'

And then execute:

$ bundle

Or install it yourself as:

$ gem install material-jekyll

Usage

  1. Create an empty project for your site [ref: github].
  2. Create index.html and set the layout. Also, put all the information on your site with Variables following the Configuration section.
  3. Add the following additional variable to _config.yml to use this remote theme. 
    remote_theme: sudharkj/material-jekyll
  4. Add any custom changes as suggested in Development based on the requirement.
  5. Follow instructions in Installation to see your changes.

Configuration

Following config variables are for the profile card on the landing page. Note that this is intended to show your profile in a short card.

variable value description
profile-link publicly accessible link image link to be shown above the profile image
profile-color any bootstrap color color to be shown in case profile-link is not provided
avatar-link link to the profile photo public link to the profile photo
name name of the person name of the person
title title of the person title of the person
caption caption to be shown caption to be shown to people
attachment-text attachment text attachment text
attachment-link attachment link publicly accessible link to the attachment
facebook link to facebook profile do not add it if not required
twitter link to twitter profile do not add it if not required
linkedin link to linkedin profile do not add it if not required
instagram link to instagram profile do not add it if not required
stack-overflow link to stack-overflow profile do not add it if not required
youtube link to youtube profile do not add it if not required
github link to github profile do not add it if not required
reddit link to reddit profile do not add it if not required
show-table-of-contents true or false whether to show table of contents
landing-page-order comma with space separated list of markdown file names markdown files showing various content is added and template takes care of formatting

Note:

  • Currently, specific dimensions are not set for profile-link and avatar-link. So, proper dimension images are to be added.
  • All referred links should be public.
  • This is a base theme to support MDB in Jekyll pages. So, custom templates are allowed by creating [LAYOUT].html in _includes and referring that in layout in index.html.

Development

  1. Clone the repository [ref: github].
  2. Make any changes to the local repository.
  3. Stash the files to git using the following command and follow the instructions in Installation to see the changes. 
    git add .

Contributing

Bug reports and pull requests are welcome on GitHub at sudharkj/material-jekyll.

License

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