templates for self-hosting game jams (or any other kind of jam tbh)
veryroundbird.house
1# Notes
2
3Explanatory dev notes to myself around where the pieces from and how they work.
4
5
6## Fuller themes
7
8- Include a screenshot in `README.md`.
9- Add `vendor/` to the ignore file - if you have dependencies.
10
11
12## Install path
13
14For some reason, the theme gets installed here:
15
16```
17vendor/bundle/ruby/2.6.0/bundler/gems/
18```
19
20Rather than:
21
22```
23vendor/bundle/ruby/2.6.0/gems/
24```
25
26This might be because I installed from a Github repo rather than a published `.gem` file on RubyGems.
27
28The project still serves though.
29
30
31## Customize
32
33Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
34
35
36The scaffold started with three minimal layout files, which have since been updated, based partially on the Minima theme.
37
38- `default.html`
39 ```
40 {{ content }}
41 ```
42- `page.html`
43 ```
44 ---
45 layout: default
46 ---
47
48 {{ content }}
49 ```
50- `post.html`
51 - Same as `page.html`.
52
53The scaffold started off with an empty `_includes` directory, but some have been added.
54
55
56## Releases
57
58When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
59
60To add a custom directory to your theme-gem, please edit the `regexp` in [jekyll-theme-quickstart.gemspec](/jekyll-theme-quickstart.gemspec) accordingly.
61
62When tagging the repo, remember to update the tag number in that file too.
63
64
65## Examples
66
67See [jekyll/minima](https://github.com/jekyll/minima) on Github as an example of a simple theme.
68
69
70## Gemspec note
71
72Notes on how the fields work, for maintaining this project or forks.
73
74See [Specification reference](https://guides.rubygems.org/specification-reference/) page on the RubyGems docs site.
75
76From the original gemspec file:
77
78```
79 spec.summary = "TODO: Write a short summary, because Rubygems requires one."
80 spec.homepage = "TODO: Put your gem's website or public repo URL here."
81```
82
83Bundle install will fail if these are not updated.
84
85This was added based on Minima:
86
87```
88 spec.metadata["plugin_type"] = "theme"
89```
90
91### Git ignore file note
92
93This was added to `Gemfile` with the scaffold:
94
95```
96*.gem
97```
98
99This is useful when building a theme before publishing.