Uswds Jekyll

screenshot of Uswds Jekyll
18f
By18f
jekyll

Uswds Jekyll

A Jekyll theme showcasing the U.S. Web Design System

Overview:

This repository is in maintenance mode and only accepting fixes. The Tech Portfolio and TTS Digital Council are working on a strategy for TTS microsites which will inform the future of this theme. Open an issue to provide any feedback. This is a Jekyll theme for the U.S. Web Design System.

Features:

  • Jekyll + U.S. Web Design System integration
  • Customizable site title and description
  • Flexible and powerful navigation system
  • Easy configuration of common elements
  • Versioning for referencing specific theme versions

Installation:

Install the theme as a Ruby Gem by adding it to your Gemfile:

gem 'uswds-jekyll'

Fetch and update bundled gems:

bundle install

Set the theme in your site's Jekyll configuration (_config.yml):

theme: uswds-jekyll

Restart your Jekyll server to see the effects.

Installing as a new Jekyll site:

  1. Create a new Jekyll site.
  2. Replace the default gem "minima" in your Gemfile line with the uswds-jekyll gem.
  3. Set the theme in your site's Jekyll configuration.
  4. Fetch and update your bundled gems.
  5. Run bundle exec jekyll serve to build your site locally at http://localhost:4000/

Summary:

This is a Jekyll theme that integrates with the U.S. Web Design System, providing a customizable and powerful platform for creating websites. It includes features such as easy installation, customization options, and a flexible navigation system. The theme is currently in maintenance mode and only accepting fixes, as the Tech Portfolio and TTS Digital Council are working on a strategy for TTS microsites which will inform the future development of this theme. Users are encouraged to provide feedback by opening an issue.

jekyll
Jekyll

Jekyll is a static site generator written in Ruby that allows you to create simple, fast, and secure websites without the need for a database.