jtebert / jekyll-polymer

A material theme for Jekyll built with Polymer
https://jtebert.github.io/jekyll-polymer/
MIT License
67 stars 18 forks source link
jekyll material polymer theme

DEMO

A Jekyll theme built with Google's Polymer library and following the material design specifications. (Currently, this uses Polymer 1.x, but I have plans to update to 2.x.)

There are a few custom web components included designed to match Material design.

I created this theme because I couldn't figure out how to set up a Jekyll project to play nicely with Polymer, and because I didn't find any Jekyll blog themes available that used Polymer or followed Google's material design specifications.

Features

Installation instructions

(Instructions are based off of those for the Polymer Starter Kit.)

Structure

Deployment

Serve/watch

gulp serve: Starts a jekyll serve process on the default port (4000 or whatever is specified in _config.yml).

gulp serve --port 6666: Start serving on port 6666

gulp serve:dist: Build as below, and serve the result from the dist/ directory. (Useful for testing changes to the gulpfile. Currently does not work with a Jekyll baseurl configured.)

Build and vulcanize

gulp: Builds the files with jekyll, vulcanizes, minimizes, and puts the result in the dist/ directory. (This can be slow.)

Deploy

gulp deploy-gh-pages: Deploy the current build to the gh-pages branch of your repository.

gulp build-deploy-gh-pages: Rebuild and then deploy. (Equivalent to gulp && gulp deploy-gh-pages)

Future Improvements:

Known issues

License

MIT License