Jekyll Material Design

Publish your static website/blog on GitHub Pages using Jekyll and Bootstrap 3 with a "materialized" style.

This project is based on Jekyll-Bootrap-3. It also includes the Paper theme from Bootswatch.com.

How it works

• Jekyll intro
• How to test your new website locally
• Build a blog with Jekyll
• It's Called Jekyll, and It Works
• Syntax Highlight Example

Usage

1. Create a Repo

• Go to https://github.com and create a new repository named USERNAME.github.io

2. Install Jekyll-Bootstrap-3

  
    $ git clone https://github.com/sentenza/jekyll-material-design USERNAME.github.io
    $ cd USERNAME.github.io
    $ git remote set-url origin [email protected]:USERNAME/USERNAME.github.io.git
    $ git push origin master  
  

3. Edit your website configuration

Edit _includes/themes/bootstrap/ to change information about your new website and also to remove the GitHub red ribbon (default.html#26).

Please, take a look at Jekyll intro to understand how GitHub and Jekyll work together to serve your pages.

4. Testing your website locally

To construct and test your site locally, go into the directory and type

jekyll build

This will create (or modify) a _site/ directory, containing everything from assets/, and then the index.md and all pages/*.md files, converted to html. (So there'll be _site/index.html and the various _site/pages/*.html.)

Type the following in order to “serve” the site. This will first run build, and so it does not need to be preceded by jekyll build.

jekyll serve

To make jekyll automatically re-build your changes you can also add the --watch option:

jekyll serve --watch

Now open your browser and go to http://localhost:4000.

Read the complete tutorial on http://jekyllrb.com/docs/usage/.

4. Enjoy !

• After giving 10 mins to GitHub of course.

For original project's usage and documentation please see the Wiki of this project.

Demo

Visit jekyll-material-design on GitHub Pages

Further resources

• Prose.io, a web-based content editor specifically designed to make it simple for content creators to publish to Jekyll

License

MIT