Theme Details
Customized theme, forked from https://github.com/artemsheludko/flexible-jekyll/
Usage
- Install
ruby,jekyll, andnpm(I personally usebrew install <product>) - If you have made any changes to the scss files, type
npm installto install the npm components, followed bynpm install node-sass. Adjust thepackage.jsonfile, if it is necessary. Executenpm run scssto build themain.cssfile. - If you want to use this as a gemfile theme, update/rename the
.gemspecfile. Then rungem build ${GEMSPEC_NAME}.gemspecto build. If you are happy with it, usegem install ${GEMSPEC_NAME}.gemspecto install it into your gem library orgem push flexible-jekyll-${VERSION}. - If you want to use this as a remote-theme, just push it to your repository in the
masterbranch.
Using the theme in a project
- If you haven't already, create a new project. You can easily do this with
Jekyll new ${sitename} - If you want to use this as a gemfile, Update your Gemfile to contain `gem "jlgrock-flexible-jekyll-theme", "0.1.0"``
- Update your Gemfile to be
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
gem "jekyll-remote-theme"
- Update your
_config.ymlfile to contain everything that is in here. Especially the plugins. - Update your
_config.ymlfile to containremote-theme: jlgrock/flexible-jekyll. You can rename this to your repo if you forked it. Just follow the format of${USER}/${REPO}@${BRANCH}. - Copy the
index.htmlandtags.htmlto your project (or create your own!). These are necessary for the tags and pagination plugins. - Create an
index.html. If you don't know what put, just use themainlayout. Now add anabout.md, extending thedefaultlayout, and atags.md, extending thetagslayout. You can make your own layouts if you'd rather. - Run
bundle installat the root of your directory - Run
bundle exec jekyll serve --safeand you should now be able to view any posts you create athttp://localhost:4000(--safeis used by GitHub, so I make sure to do this as well).