Powerful new theme featuring Semantic UI for speedily creating amazing websites and mobile-hybrid apps on GitHub Pages.
HTML JavaScript CSS Ruby Other
Latest commit f6fb95d Dec 22, 2015 @manavsehgal Update README.md
Permalink
Failed to load latest commit information.
_data Optional GA include Jan 15, 2015
_images Image optimization to Gulp Jan 14, 2015
_includes Optional mailchimp, addthis, other features in config Jan 15, 2015
_layouts Optional mailchimp, addthis, other features in config Jan 15, 2015
_posts Quick Publish Jan 10, 2015
_sass JSHint, Uglify added to Gulp Jan 14, 2015
coffee JSHint, Uglify added to Gulp Jan 14, 2015
css JSHint, Uglify added to Gulp Jan 14, 2015
img Image optimization to Gulp Jan 14, 2015
js JSHint, Uglify added to Gulp Jan 14, 2015
script Quick Publish Jan 7, 2015
static-data Simpler Front Matter for Fusion Apps Jan 10, 2015
.csslintrc JSHint, Uglify added to Gulp Jan 14, 2015
.gitignore .gitignore .c9/ Jan 16, 2015
.htaccess .htaccess as per mrmrs/nkd Dec 30, 2014
.jshintrc JSHint, Uglify added to Gulp Jan 14, 2015
.travis.yml chmod executable on cibuild.sh Dec 24, 2014
CNAME Added CNAME for opentheme.co Nov 26, 2014
Gemfile Optional GA include Jan 15, 2015
Gemfile.lock Optional GA include Jan 15, 2015
LICENSE Initial commit Nov 19, 2014
README.md Update README.md Dec 23, 2015
_config.yml Optional mailchimp, addthis, other features in config Jan 15, 2015
apps.html Quick Publish Jan 7, 2015
blog.html Blog to dark-wood wallpaper Dec 24, 2014
bower.json FlexSlider cdnjs ver used Dec 30, 2014
category.html Changed cibuild to just Jekyll build test Dec 24, 2014
embeds.html All Embeds Page. Footer RSS link. Dec 21, 2014
favicon.ico Favicon updated Nov 30, 2014
feed.xml Sitemap.xml added. Feed.xml updated. Dec 16, 2014
google9cf5b33ea59368cf.html Google Webmaster verification html added Dec 16, 2014
gulpfile.js Gulp Watch _includes Jan 15, 2015
index.html Homepage benefits ribbon added Jan 16, 2015
kitchensink.html Fix kitchensink img paths Dec 30, 2014
metrics.html Metrics PageSpeed Suggestions Jan 6, 2015
package.json Image optimization to Gulp Jan 14, 2015
panoramio.html Updated post images Dec 15, 2014
robots.txt Fix Sitemap Jan 11, 2015
search.html Optional mailchimp, addthis, other features in config Jan 15, 2015
sitemap.xml Sitemap.xml added. Feed.xml updated. Dec 16, 2014
tag.html Changed cibuild to just Jekyll build test Dec 24, 2014

README.md

OpenTheme

Powerful new theme featuring Semantic UI for speedily creating amazing websites and mobile-hybrid apps on GitHub Pages.

Getting Started

Fork and Publish Direct from GitHub

  1. Fork OpenTheme as your own repo
  2. IMPORTANT: Edit _config.yml -> "API Keys" section to replace OpenTheme keys with your own
  3. Edit and publish _posts, or _data, or pages directly from GitHub

Local Setup

bundle install # Install Jekyll, Github Pages gems
npm install # Install Gulp and dependences
gulp # Build, test, serve and watch your local setup

IMPORTANT: Edit _config.yml -> "API Keys" section to replace OpenTheme keys with your own

Optionally edit gulpfile.js -> BrowserSync host, port to your local setup

Optionally, helper bash scripts available in /scripts folder. Use shove.sh to push changes to your repo. Use clone.sh to copy changes to GitHub Pages.

File Structure

Folders Pre-processed by GitHub Pages / Jekyll

  • _includes html partials reusable in layouts.
  • _layouts html layouts reusable in pages.
  • _posts Post types organized by folder. apps contains single page apps. blog contains blog posts.
  • _data Static data files including YAML Front Matter, CSV, JSON formats usable by GitHub Pages sites.

Asset Folders

  • js add site specific JavaScript to custom.js. Vendor libraries are added as minified where available.
  • css add site specific CSS to custom.css. Vendor libraries are added as minified where available. Contains folders for assets referenced by custom or vendor css.
  • img image assets.

Development Automation

  • script Automation shell scripts for development, testing. [TO DO] Replace with Gulp pipeline automation, E2E, Lint tests.

Files

  • Gemfile defines gems required for creating local Jekyll building and serving "like" how GitHub Pages would.

Dependencies

  • Semantic UI
  • Jekyll

Reference Projects

Study following projects for best practices.

Jekyll built sites and themes

GitHub hosted sites