Merge branch 'main' into alifeee-patch-1

README.md

@@ -2,30 +2,85 @@
 
 This is the website for Sheffield Hackspace. The site is written using [Jekyll](https://jekyllrb.com/). Posts and updates from members are welcome just make a PR.
 
+## Styles
+
+### Fonts
+
+The header font used is ["Big Noodle Titling"] ([WOFF2][bntwoff2]).
+
+![Screenshot of header, showing big noodle titling font](https://github.com/sheffieldhackspace/Public-Website/assets/13833017/af3c202b-37b4-4dce-8579-442e79ae201e)
+
+The body font used is ["Fira Sans"].
+
+![Screenshot of body, showing Fira Sans font](https://github.com/sheffieldhackspace/Public-Website/assets/13833017/e759a4c9-15c0-4bd2-ba1b-f124288f9d33)
+
+["Big Noodle Titling"]: https://www.dafont.com/bignoodletitling.font
+[bntwoff2]: https://www.sheffieldhackspace.org.uk/assets/fonts/big_noodle_titling-webfont.woff2
+["Fira Sans"]: https://fonts.google.com/specimen/Fira+Sans
+
 ## Making changes
 
 All changes should be made as a pull request to main. All changes require a PR review from one trustee.
 
-### Using Docker
+### How to build
+
+#### Using Docker
 
 Install docker and docker compose.
 
 To start the site run `docker-compose up` then navigate to `http://localhost:4000/Public-Website/` in your browser
 
 To update the `gemfile.lock` if you have changed a plugin run `docker-compose run jekyll bundle update`
 
-## Styles
+#### Using Jekyll locally
 
-### Fonts
+**Note: for debugging only**, you should use [Docker](#using-docker) to see the website as it will look [when built](./.github/workflows/build-and-deploy.yml).
 
-The header font used is ["Big Noodle Titling"] ([WOFF2][bntwoff2]).
+```bash
+sudo apt-get install ruby-full
+gem install bundler
+bundle config set --local path 'vendor/bundle'
+bundle install
+```
 
-![Screenshot of header, showing big noodle titling font](https://github.com/sheffieldhackspace/Public-Website/assets/13833017/af3c202b-37b4-4dce-8579-442e79ae201e)
+Serve. This is the same command used in [the docker compose file](./docker-compose.yml).
 
-The body font used is ["Fira Sans"].
+```bash
+bundle exec jekyll serve --watch --force_polling --verbose
+```
 
-![Screenshot of body, showing Fira Sans font](https://github.com/sheffieldhackspace/Public-Website/assets/13833017/e759a4c9-15c0-4bd2-ba1b-f124288f9d33)
+### How to add a blog post
 
-["Big Noodle Titling"]: https://www.dafont.com/bignoodletitling.font
-[bntwoff2]: https://www.sheffieldhackspace.org.uk/assets/fonts/big_noodle_titling-webfont.woff2
-["Fira Sans"]: https://fonts.google.com/specimen/Fira+Sans
+1. Add a markdown file to [`_posts`](./_posts/) of the format `2024-03-09-font-workshop.md`
+2. Add front matter meta data. This can be copied and edited from another post. An example is
+
+    ```yaml
+    ---
+    id: 2150
+    title: 'Computer font making workshop'
+    date: '2024-03-09T00:05:46+01:00'
+    author: 'alifeee'
+    layout: post
+    guid: 'https://www.sheffieldhackspace.org.uk/?p=2150'
+    permalink: /font-workshop/
+    categories:
+        - Uncategorized
+    tags:
+        - workshop
+    ---
+    ```
+
+    For `ID`, add 10 to the previous post `ID`. For `guid`, use the `ID`. For other keys, make an educated guess or copy from a previous post.
+
+3. For images:
+
+    1. Add a folder under [`/assets/blog/`](./assets/blog/) with the same name as the blog post.
+    2. Use markdown image formatting, and use the `{{ baseurl }}` short code for the base URL. For example
+
+       ```md
+       ![Hand-drawn sign saying "font making workshop"]({{ site.baseurl }}/assets/blog/2024-03-09-font-workshop/workshop-sign.jpg)
+       ```
+
+4. Create a pull request!
+
+    1. It is helpful if you enable GitHub pages on your repository Fork, so a preview can be seen.