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
-[Updating an existing page](#updating-an-existing-page)
19
-
-[Updating side nav links](#updating-side-nav-links)
20
-
-[Testing locally](#testing-locally)
18
+
-[Adding a page (example)](#adding-a-page-example)
19
+
-[Updating side nav links](#updating-side-nav-links)
20
+
-[Updating the styling ](#updating-the-styling)
21
21
-[Original Author](#original-author)
22
22
-[License](#license)
23
23
24
+
24
25
## Directory organization of Repo
25
26
26
27
(only highlighting folders and files relevant to updating site)
@@ -49,6 +50,7 @@ Included are instructions for how to update the team website with a focus on the
49
50
50
51
```
51
52
53
+
52
54
## MUST READ - how jekyll works
53
55
54
56
1. How jekyll knows to work its magic on a markdown or html file is based on the file's [YAML front matter block](https://jekyllrb.com/docs/front-matter/).
@@ -67,6 +69,7 @@ Included are instructions for how to update the team website with a focus on the
67
69
68
70
-**Do not alter the files in `_includes`, `_layouts` for now.**
69
71
72
+
70
73
#### Home page (default) vs. all other pages
71
74
72
75
- How jekyll knows to work its magic on a markdown or html file is based on the file's [YAML front matter block](https://jekyllrb.com/docs/front-matter/).
@@ -84,97 +87,81 @@ Included are instructions for how to update the team website with a focus on the
84
87
permalink: /about/
85
88
---
86
89
```
87
-
88
90
-`layout: page` is to be used for almost all of the pages you want included in the site
89
-
90
91
-`layout: default` is only used for the home page [index.md](index.md) because it has some additional formatting + appears as the first option in the top menu bar
91
-
92
92
>From the Hyde repo: "**Why require a specific layout?** Jekyll will return *all* pages, including the `atom.xml`, and with an alphabetical sort order. To ensure the first link is *Home*, we exclude the `index.md` page from this list by specifying the `default` layout."
93
93
94
94
95
95
## Updating website content
96
96
97
97
- To update the contents of the website you will only need to add/remove/update markdown files in the main directory.
98
-
99
98
- To incorporate images or any other files into the site please put them in `/public/assets/`
100
99
100
+
#### (OPTIONAL) Previewing changes locally
101
+
If you want to test/preview the site locally as you make changes
5. To preview your changes don't forget to save your file and refresh the browser.
101
108
102
109
#### Updating an existing page
103
110
104
111
1. Clone this repository
105
112
2. Create a branch from the 'master' branch of THIS repository (not the poole/hyde one)
106
-
3.
107
-
108
-
- In the main directory, open the markdown file
109
-
- make whatever changes to the content you want
110
-
- save it and push changes
113
+
3.In the main directory, open the markdown file you want to update e.g. [3people.md](3people.md)
114
+
4. make whatever changes to the content you want
115
+
5. save the file
116
+
6. push the changes to your branch
117
+
7. Make a pull request for your branch into the MoNA Master branch then jekyll will take care of the rest
111
118
112
119
(it's that easy :smiley:)
113
120
114
121
115
-
116
-
117
122
#### Adding a page (example)
118
-
119
123
Let's say you want to add a 'Contact' page and it should appear as the last option on the top menu bar
120
124
121
-
- create a markdown file in the main directory
122
-
123
-
- since 'page.html' pages are sorted alphabetically, if you want the Contact page to be last in the menu prefix the markdown filename with a '9' or 'z' for example
124
-
125
-
- in the markdown file, the front matter should look like this:
125
+
1. Steps 1-3 in [Updating an existing page](#updating-an-existing-page)
126
+
2. Create a markdown file in the root directory. Since pages are sorted alphabetically, if you want the Contact page to be last in the menubar of the website, prefix the markdown filename with a '9' or 'z' for example
127
+
3. In the markdown file, the front matter should look like this:
126
128
127
-
```
128
-
---
129
-
layout: page
130
-
title: Contact
131
-
permalink: /contact/
132
-
---
133
-
```
134
-
- the layout should be 'page', to tell jekyll to use the page.html layout
135
-
- the title is what will be used in the top menu bar
136
-
- assigning a permalink will overwrite the default of using the filename (e.g., *https:// ... io/9contact/*:thumbsdown:)
137
-
138
-
- underneath the front matter include whatever content you would like
139
-
140
-
- you can add formatting to the file using markdown or html syntax
141
-
142
-
- when done save and push changes, jekyll will take care of the rest
143
-
144
-
145
-
## Updating the styling
146
-
147
-
- Extra: Updates to formating is done in the 3 directories: `/_includes/``/_layouts/` and `/_public/`
148
-
149
-
### Updating side nav links
150
-
151
-
The file that needs to be updated is `/_inclues/sidebar.html`
152
-
153
-
Look for the `sidebar-nav-item` tags
129
+
```
130
+
---
131
+
layout: page
132
+
title: Contact
133
+
permalink: /contact/
134
+
---
135
+
```
136
+
- the layout should be 'page', to tell jekyll to use the page.html layout
137
+
- the title is what will be used in the top menu bar
138
+
- assigning a permalink will overwrite the default of using the ugly filename (e.g., `... .github.io/contact/` instead of `... .github.io/9contact/`)
154
139
140
+
4. Underneath the front matter include whatever content you would like. You can add formatting to the file using markdown or html syntax.
141
+
5. Steps 5-7 in [Updating an existing page](#updating-an-existing-page)
155
142
156
143
144
+
#### Updating side nav links
145
+
- similar steps to those in [Updating an existing page](#updating-an-existing-page)
146
+
- However, the file that needs to be updated is `/_includes/sidebar.html`
147
+
- Look for the `sidebar-nav-item` tags
157
148
158
-
### Testing locally
159
149
160
-
If you want to test/preview the site locally as you make changes
0 commit comments