Upstream Community Theme
The Upstream Community Theme is a ready-to-use Jekyll theme to help you create a basic static site for your project. It was designed with the Red Hat Upstream Community in mind, but can be used by anyone looking to create a simple, lightweight site.
These instructions will get you a copy of the project up and running on your local machine for development purposes. See deployment for notes on how to deploy the project on GitHub Pages.
- Install a full Ruby development environment. Ruby version 2.4.0 or above is required, including all development headers. You can run
ruby -vto check your current Ruby version.
- RubyGems. You can run
gem -vto check if you have RubyGems installed.
- GCC and Make. You can run
make -vto see if your system already has them installed.
Installing the theme
- The Jekyll site provides detailed installation instructions for each operating system:
- Fork this repository by clicking the Fork button at the top right corner of this page.
- Clone your fork (please ensure you have current version of git installed) by running:
git clone email@example.com:YOUR_USER_NAME/community-theme.git
- Change into the project directory
- Build the site and make it available on a local server
bundle exec jekyll serve
- To preview your site, browse to http://localhost:4000
For more information regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.
Using Docker to run Jekyll
Alternatively you can use Docker to test your changes locally.
To run it, simply execute the following Docker command from the project root directory:
docker run --rm --volume="$PWD:/srv/jekyll" -it -p 4000:4000 jekyll/jekyll:3 jekyll serve
To preview your site, browse to http://localhost:4000
Deployment on GitHub Pages
To deploy your site using GitHub Pages you will need to add the github-pages gem.
Note that GitHub Pages runs in
safemode and only allows a set of whitelisted plugins.
To use the github-pages gem, you'll need to add the following on your
source "https://rubygems.org" gem "github-pages", group: :jekyll_plugins
And then run
To deploy a project page that is kept in the same repository as the project they are for, please refer to the Project Pages section in Deploying Jekyll to GitHub Pages.
Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.
This project is licensed under the MIT License - see the LICENSE.md file for details.