Skip to content

Latest commit

 

History

History
66 lines (45 loc) · 2.16 KB

README.md

File metadata and controls

66 lines (45 loc) · 2.16 KB
Raw

2020.pyconuk.org

PyCon UK 2020 website

Building Locally

Installing Jekyll

This site is made using Jekyll. Jekyll is a static site generator written in ruby. To build the project we first need to check that we have Jekyll's requirements installed.

These are:

You can check if you have these installed by typing <command> -v in your terminal. If the program is available on your system then you should see the version of the program that is installed outputted in your terminal.

For example if Ruby in installed and you run ruby -v, you should get output like this ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-linux]. If RugbyGems is not installed an you run gem -v you should get an error like this bash: gem: command not found

See the Jekyll documentation for more information on install Jekyll and its requirements.

Now that you have all of Jekyll's requirements installed you can install Jekyll itself.

gem install jekyll bundler

Installing project dependencies

To install the projects dependencies run

bundle install

If you get a permissions error when doing this make sure you have the following in your shell rc file (e.g. ~/.bashrc, ~/.zshrc, etc)

export GEM_HOME="$HOME/gems"
export PATH="$HOME/gems/bin:$PATH"

Building the project locally

You can now build the project locally.

bundle exec jekyll build

This generates the directory build that contains all the files needed for the site. You can now run an http server in that directory or use jekyll to serve the project.

bundle exec jekyll serve

This will start a webserver on http://127.0.0.1:4000/. To view the website open http://127.0.0.1:4000/ in your favorite web browser. This will also automatically rebuild the project when a change to the source is detected.