jekyll-theme-upskill

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in _layouts, your includes in _includes, your sass files in _sass and any other assets in assets.

To experiment with this code, add some sample content and run bundle exec jekyll serve – this directory is setup just like a Jekyll site!

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-upskill"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-theme-upskill

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-upskill

Usage

Menu

To generate menu add the menus section to you _config.yaml file. Example:

menus:
    - title: Home
      url: index.html

Table of content

To generate proper table of content add sections sections to your page. Example

sections:
  - id: sec1
    title: Section 1
  - id: sec2
    title: Section 2

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in jekyll-theme-upskill.gemspec accordingly.

License

The theme is available as open source under the terms of the MIT License.