Overview:
DEMOA is a Jekyll theme that utilizes Google’s Polymer library and follows the material design specifications. The theme includes custom web components that are designed to match Material design. The purpose of creating this theme was to provide a Jekyll blog theme that uses Polymer and follows Google’s material design specifications.
Features:
- Full-text search with simple-jekyll-search
- Paginated home page
- Support for featured post images
- Threaded comments with Disqus
- Google Analytics integration
- One-command deployment to Github Pages
- Tagged posts with archive by tag
- Authorship with Gravatar icons
Installation:
- Clone this repository or download it as a .zip file and unzip.
- Install jekyll (and any other Ruby gems) with
bundle install. (Prerequisite: must have Ruby installed; in Ubuntu/Debian, usesudo apt-get install ruby-dev. You may also have to install bundler withgem install bundler.) - From the project root folder, run
npm install -g gulp bower && npm install && bower install. (See the old Polymer Starter Kit installation instructions for more details or troubleshooting.)
Structure:
- app/: All Jekyll content is here. (This is where all the editing happens)
- bower_components: Content installed via bower ends up here
- elements/: Custom web components using Polymer
- images/: User images
- media/: Other user content (PDFs, videos, etc.) for final product
- scripts/: Javascript files
- styles/: Custom CSS
- _data/authors.yml: List of authors for posts and pages
- dist/: Built output from Gulp. (Use to publish static content)
- node_modules: Content installed via npm goes here
Deployment:
- 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.)
- gulp: Builds the files with jekyll, vulcanizes, minimizes, and puts the result in the dist/ directory. (This can be slow.)
- 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)
Summary:
DEMOA is a Jekyll theme built with Google’s Polymer library and follows the material design specifications. It includes features such as full-text search, paginated home page, support for featured post images, threaded comments, Google Analytics integration, and one-command deployment to Github Pages. The theme also provides installation instructions and a structure guide for easy customization.