templates for self-hosting game jams (or any other kind of jam tbh)
veryroundbird.house
1# Gem
2
3## Install system dependencies
4
5Install Ruby and Bundler for your user - see [gist](https://gist.github.com/MichaelCurrin/3af38fca4e2903cdedfb8402c18b2936).
6
7
8## Setup the theme
9> Install theme dependencies and build the theme gem
10
11Note that this sets up dependencies for the theme so that it can be packaged as a gem. Continue to a later section on this page for starting a server.
12
13
14### Clone
15
16Clone the repo:
17
18```sh
19$ git clone git@github.com:MichaelCurrin/jekyll-theme-quickstart.git
20$ cd jekyll-theme-quickstart
21```
22
23### Install project dependencies
24
25Install gems using Bundler:
26
27```sh
28$ make install
29```
30
31This will not install the theme itself, just the dependencies in [Gemfile](/Gemfile):
32
33- `gemspec`
34
35
36### Build
37
38If you use the Remote Theme plugin to load your theme on GH Pages, you can skip this section, as that only needs a `*.gemspec` file and not an
39
40This build step will package your theme as a `*.gem` archive file, which can downloaded and installed from RubyGems or GitHub.
41
42```sh
43$ make build-gem
44```
45```
46gem build jekyll-theme-quickstart.gemspec
47 Successfully built RubyGem
48 Name: jekyll-theme-quickstart
49 Version: 0.3.0
50 File: jekyll-theme-quickstart-0.3.0.gem
51```
52
53### Start dev server
54
55Note:
56
57- With no HTML or markdown pages, you'd normally just see a directory listing by default.
58- A single demo page has been added for easy testing. This will not be included as a file installing the project into another project.
59- You'll get warnings about no config and if you look at the `_site` directory you'll see some files you would not expect. This is okay as it does not affect local serving and it avoids adding a config to the project.
60
61Test the theme using a demo file - [index.md](/index.md).
62
63```sh
64$ make serve
65```
66
67Open your browser at:
68
69- [localhost:4000](http://localhost:4000)