Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 1.67 KB

README.md

File metadata and controls

47 lines (36 loc) · 1.67 KB
Raw

Starterkit

The source code for the website for the LHCb Starterkit organisation.

Building the website

The site is built automatically whenever the gh-pages branch is updated on GitHub.

To build the site locally, you need to install the github-pages gem and then run Jekyll, a program that converts the collection of HTML templates and Markdown files in this repository to full HTML pages. Assuming you have Ruby installed on your machine, which should be the case on anything but Windows, inside this repository you can do:

$ gem install bundler
$ bundle install --path=vendor/bundle
$ bundle exec jekyll build

(The use of the --path option in bundle install and of bundle exec makes the dependency installation local to the folder containing the repository, so that your ‘global’ list of gems isn't touched.)

This will build the site into the _site directory, and you can then open _site/index.html in your browser to see the site.

To have Jekyll monitor the repository for changes and serve the website on a local development server, do:

$ bundle exec jekyll serve --watch

You can visit the site using the local address http://127.0.0.1:4000/starterkit/.