icodein / jekyll-theme-stellar

:stars: A Jekyll port of HTML5UP stellar theme

Stellar - Jekyll theme

A Jekyll version of the "Stellar" theme by HTML5 UP.

You can preview the template here.

Features

Responsive: out of the box support for all screen sizes, be it smartphones, laptops, tablets...

Multilingual: easily manage pages, menu, url, dates, sitemap in several languages

Customizable: theme colors, menu, social items can be changed from a central config file

Many page templates: contact forms, navigation menus, and others can be easily inserted thanks to custom Jekyll includes

Vector images: the theme images are vectorized, render smoothly on any display and can be dynamically styled

GDPR ready: bundled with a cookie consent plugin and a boilerplate privacy policy compliant with GDPR

SEO ready: sitemap, robots.txt and tags are automatically generated for the website

Light: svg images, thumbs and lazy loading for raster images, few libraries

Hardened: form validation, recaptcha, verified libraries

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-stellar"

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

theme: jekyll-theme-stellar

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-stellar

Usage

For those unfamiliar with how Jekyll works, check out jekyllrb.com for all the details, or read up on just the basics of front matter, writing posts, and creating pages.

Initialization

Copy the file _config.yml from the theme repository to the root of your website folder tree. The following section explains what the settings impact and how to configure _config.yml properly.

Configuration

You can use the following custom parameters in _config.yml.

Site

Both title and subtitle are displayed side by side :

• in the tab name
• at the top of the page, in the header

Social

Social icons will appear for each url your fill in, among facebook_url etc.

Contact

Your contact information can be used in contact forms, the footer or anywhere else.

Recaptcha

The contact form is validated using google's recaptcha plugin. First, you need to [sign your website up] to enable the plugin. Google will provide you with a client-side integration key: copy it to _config.yml under recaptcha.sitekey.

Publication

On Github Pages

In your own website's repository, edit the _config.yml file:

url: "https://<github-account-name>.github.io/<repository-name>"

Build the website with:

$ JEKYLL_ENV=production bundle exec jekyll build

Commit all your work to the current branch.

Create a branch named gh-pages:

$ git checkout -b gh-pages

And finally replace the repository's content with the generated webpages:

$ mkdir ~/backup
$ mv ./* ~/backup/
$ mv ~/backup/.git ./
$ mv ~/backup/_site/* ./
$ git add .
$ git commit -m "First draft"

The repository's content is backup in the home directory of the user.

And finally push to github

$ git push --u origin gh-pages

On any server

In your own website's directory, edit the _config.yml file:

url: "https:<domain-name>"

Build the website with:

$ JEKYLL_ENV=production bundle exec jekyll build

Copy the content of the folder _site to your server, most likely in www.

If necessary, configure your server to serve this directory.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/moodule/jekyll-theme-stellar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

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-stellar.gemspec accordingly.

Credits

Original README from HTML5 UP:

Stellar by HTML5 UP
html5up.net | @ajlkn
Free for personal and commercial use under the CCA 3.0 license (html5up.net/license)


Say hello to Stellar, a slick little one-pager with a super vibrant color palette (which
I guess you can always tone down if it's a little too vibrant for you), a "sticky" in-page
nav bar (powered by my Scrollex plugin), a separate generic page template (just in case
you need one), and an assortment of pre-styled elements.

Demo images* courtesy of Unsplash, a radtastic collection of CC0 (public domain) images
you can use for pretty much whatever.

(* = not included)

AJ
[email protected] | @ajlkn


Credits:

    Demo Images:
        Unsplash (unsplash.com)

    Icons:
        Font Awesome (fontawesome.io)

    Other:
        jQuery (jquery.com)
        Scrollex (github.com/ajlkn/jquery.scrollex)
        Responsive Tools (github.com/ajlkn/responsive-tools)

Inspired by the Jekyll ports of Andrew Banchich.

Uses the basic template from the cookie consent plugin.

Repository Jekyll logo icon licensed under a Creative Commons Attribution 4.0 International License.

License

The theme is available as open source under the terms of the CC-BY-3.0.