Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 3.9 KB

README.md

File metadata and controls

73 lines (48 loc) · 3.9 KB
Raw

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.

Getting Started

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.

Prerequisites

  • Install a full Ruby development environment. Ruby version 2.4.0 or above is required, including all development headers. You can run ruby -v to check your current Ruby version.
  • RubyGems. You can run gem -v to check if you have RubyGems installed.
  • GCC and Make. You can run gcc -v,g++ -v and make -v to see if your system already has them installed.

Installing the theme

Jekyll documentation pages

  1. The Jekyll site provides detailed installation instructions for each operating system:
  1. Fork this repository by clicking the Fork button in the top right corner of this page.
  2. Clone your fork (please ensure you have current version of git installed) by running: git clone [email protected]:YOUR_USER_NAME/infinispan.github.io.git
  3. Change into the project directory cd infinispan.github.io
  4. Optionally, set bundle install path bundle config set path $HOME/.bundle
  5. Download and install required RubyGems bundle install
  6. Optionally, forced documentation downloading on every jekyll serve can be skipped with export FORCE_DOCUMENTATION_DOWNLOAD=false
  7. Build the site and make it available on a local server bundle exec jekyll serve
  8. To preview your site, browse to http://localhost:4000

If you encounter any unexpected errors during the above, please refer to the troubleshooting page or the requirements page, as you might be missing development headers or other prerequisites.

For more information regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.

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 safe mode and only allows a set of whitelisted plugins.

To use the github-pages gem, you'll need to add the following on your Gemfile:

source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins

And then run bundle update.

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.

Contributing

Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details.