You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It's all free, so if you're in the area please come along!
8
8
9
-
# To add yourself to the people page
9
+
You can see our current events at https://www.codewith.org.uk/events.html
10
+
11
+
# Contributing to this repository
12
+
## Repository branches
13
+
14
+
Branch | Purpose | Who can commit
15
+
------------ | ------------- | ---------------
16
+
Master | The **Live** branch, commits here will appear in the live website | Maintainers, only from the release branch
17
+
Release | Tested code that is ready for the live website | Maintainers, via pull requests
18
+
Feature/* | New code being developed | Contributors
19
+
20
+
## Pull requests
21
+
22
+
Please submit pull requests with useful descriptions, if you don't know how to use pull requests ask in [our Slack group](https://www.codewith.org.uk/contact.html).
23
+
24
+
25
+
## Testing
26
+
27
+
Testing is important for maintainers and contributors alike. Ensure all aspects of the site work as the did previously before submitting a pull request.
28
+
29
+
Things to look out for when testing
30
+
31
+
* Responsive design - how does the page display on different devices, and different orientations.
32
+
* Browser support - Test your changes in a few major browsers, are there any errors?
33
+
34
+
Before pull requests are merged maintainers should test all aspects of the site.
35
+
36
+
# Getting started with this site and Jekyll
37
+
38
+
## What is Jekyll?
39
+
40
+
Jekyll is a static site generator. It takes text written in your favorite markup language and uses layouts to create a static website. You can tweak the site’s look and feel, URLs, the data displayed on the page, and more.
41
+
42
+
Quoted from https://jekyllrb.com/docs/
43
+
44
+
## Jekyll setup
45
+
46
+
Use [this guide](https://jekyllrb.com/docs/installation/) to setup Jekyll for your operating system.
47
+
48
+
## Building the site
49
+
50
+
Open a command line in the root directory of the repository
51
+
52
+
Run `jekyll build` to build the site, this will produce a `_site` folder with the required content
53
+
54
+
>:Warning: do not edit anything in the site folder as it will not be comitted and is overwritten everytime you build the site.
55
+
56
+
To rebuild the site after a file change append `--watch` to the end of the command.
57
+
58
+
e,g. `jekyll build --watch`
59
+
60
+
Once you have a `_site` folder open the `index.html` file inside to view the site.
61
+
62
+
## Includes
63
+
64
+
Jeykll has functionality to include files, which this site makes extensive use of. You can find the documentation for includes here: https://jekyllrb.com/docs/includes/
65
+
66
+
# Useful guides
67
+
68
+
## To add yourself to the people page
10
69
11
70
* Create a branch
12
71
* Make a copy of one of the existing bios in *_data/people/*
@@ -22,11 +81,11 @@ If you need any help, contact one of the pople who have already added themselves
22
81
# Sitemap
23
82
All pages not defined as a default in _config.yml are added to the sitemap
24
83
25
-
To exclude a specific page use the snippet `sitemap:false` at the top of the page
84
+
To exclude a specific page use the snippet `sitemap:false` at the top of the page
26
85
27
-
> :warning:**If you are including the page in another page (using `include_relative`)**: add the page as a default in `_config.yml` otherwise the `sitemap:false` is displayed as HTML on the page.
86
+
:warning:**If you are including the page in another page (using `include_relative`)**: add the page as a default in `_config.yml` otherwise the `sitemap:false` is displayed as HTML on the page.
28
87
29
-
## Example default to add to `_config.yml`
88
+
###Example default to add to `_config.yml`
30
89
```yml
31
90
-
32
91
scope:
@@ -36,14 +95,21 @@ To exclude a specific page use the snippet `sitemap:false` at the top of the pag
36
95
```
37
96
38
97
All files in `_include` are excluded from the sitemap automatically
39
-
# Adding a page to the typed suffix functionality
40
-
* Add a variable to the suffix-lists.js file with the first word of the page title. Assign the array you want to use to the variable.
98
+
## Adding a page to the typed suffix functionality
99
+
100
+
* Add a key to the Jekyll build options at the top of the page
Copy file name to clipboardExpand all lines: _includes/head.html
+1-2Lines changed: 1 addition & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -41,9 +41,8 @@
41
41
<linkrel="stylesheet" href="css/sidebar.css">
42
42
43
43
<!-- I know scripts aren't supposed to go in the header, but we need this here in order to pick different suffix lists for the typewriter at the top -->
0 commit comments