https://github.com/sentenza/jekyll-material-design

Jekyll Bootstrap 3 with the material design flavour. Publish your materialized blog using GitHub Pages easily.
https://github.com/sentenza/jekyll-material-design

bootstrap3 jekyll jekyll-material jekyll-theme

Last synced: 2 months ago
JSON representation

Jekyll Bootstrap 3 with the material design flavour. Publish your materialized blog using GitHub Pages easily.

• Host: GitHub
• URL: https://github.com/sentenza/jekyll-material-design
• Owner: sentenza
• License: mit
• Created: 2014-10-05T16:22:41.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-10-02T17:23:21.000Z (about 6 years ago)
• Last Synced: 2024-09-28T15:43:01.250Z (3 months ago)
• Topics: bootstrap3, jekyll, jekyll-material, jekyll-theme
• Language: HTML
• Homepage: https://sentenza.github.io/jekyll-material-design
• Size: 814 KB
• Stars: 65
• Watchers: 8
• Forks: 21
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.markdown
  • License: LICENSE

Awesome Lists containing this project

README

        
Jekyll Material Design 

======================

Publish your static website/blog on GitHub Pages using [Jekyll](https://jekyllrb.com/) and [Bootstrap 3](https://github.com/twbs/bootstrap) with a *"materialized"* style.

This project is based on [Jekyll-Bootrap-3](https://github.com/dbtek/jekyll-bootstrap-3). It also includes the [Paper theme](http://bootswatch.com/paper) from [Bootswatch.com](http://bootswatch.com).

![Jekyll-material-design Thumbnail](https://github.com/sentenza/jekyll-material-design/blob/master/assets/images/jekyll-bootstrap.png "Jekyll material design default theme")

#### How it works

 - [Jekyll intro](http://sentenza.github.io/jekyll-material-design/lessons/2014/02/10/jekyll-intro)

 - [How to test your new website locally](http://sentenza.github.io/lessons/2016/01/17/testing-locally/)

 - [Build a blog with Jekyll](https://www.smashingmagazine.com/2014/08/build-blog-jekyll-github-pages/)

 - [It's Called Jekyll, and It Works](https://developmentseed.org/blog/2013/10/24/its-called-jekyll/)

 - [Syntax Highlight Example](http://sentenza.github.io/jekyll-material-design/lessons/2014/02/13/syntax-highlight-example)

## Usage

### 1. Create a Repo

- Go to  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](https://github.com/sentenza/jekyll-material-design/blob/master/_includes/themes/bootstrap/default.html#L26)).

Please, take a look at [Jekyll intro](http://sentenza.github.io/jekyll-material-design/lessons/2014/02/10/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 .

Read the complete tutorial on .

### 4. Enjoy !

- After giving 10 mins to GitHub of course.  

For original project's usage and documentation please see the [Wiki of this project](https://github.com/sentenza/jekyll-material-design/wiki).

## Demo

Visit [jekyll-material-design](https://sentenza.github.io/jekyll-material-design) on GitHub Pages

## Further resources

- [Prose.io](http://prose.io/#about), *a web-based content editor specifically designed to make it simple for content creators to publish to Jekyll*

## License

[MIT](http://opensource.org/licenses/MIT)