Stately (currently in alpha)

Stately is the Jekyll theme for government. Stately’s modern setup and design is specifically geared toward goverment oriented websites.

Installation (coming soon as Ruby gem)

Usage

For full setup instructions read the See the Getting started guide.

Edit _config.yml to being setting up Stately for your website. In addition to the default Jekyll settings, Stately includes some additional:

# Stately settings
nav_logo_file: assets/images/stately-logo.png # path to the logo file for the main nav (supports svg, png, jpg, gif). Delete this line for no logo.
footer_logo_file: assets/images/stately-logo.png # path to the logo file for the footer nav (supports svg, png, jpg, gif). Delete this line for no logo.
github_link: true # Display link to edit page content on GitHub. Delete this line or set to false for no link.
github_pages_branch: master # Branch where gh-pages site is hosted (either master, master/docs, or gh-pages). Delete this line for no GitHub pages branch.

## Info bar settings
# info_bar: true # Bar at the top of all pages. Delete this line or set to false for no info bar display.
# info_bar_text: This is not an offical site of the <a href="//usa.gov" class="text-white text-underline">U.S. Government</a> # Only shows if info_bar == true

See the Configuration docs for more information.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/stately. 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

Environment setup

To set up your environment to develop this theme, clone this repo and install the dev dependancies:

$ bundle install

$ npm install

You 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.

Tests

To run tests on SCSS and HTML run:

$ script/test

Releases

To prepare bundle a new version of the Gem:

• Rev the version number in package.json
• Rev the version number in stately-jekyll.gemspec
• Update the CHANGELOG.md
• Run the build script

$ script/build

License

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