Skip to content

Commit fc76aca

Browse files
committed
Add navigation setup to README
1 parent e8a8823 commit fc76aca

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,23 @@ included. Follow the instructions below for complete setup.
3232
3. Install the theme by running `bundle install` inside your site directory.
3333
4. Replace the current theme in your `_config.yml` file with
3434
`theme: jekyll-theme-cleaner-blog`.
35-
<!-- TODO: Describe adding `navigation` to `_config.yml` -->
36-
5. Build your site: `bundle exec jekyll serve`
35+
5. Add the following variable to your `_config.yml`:
36+
```yaml
37+
navigation:
38+
- name: Home
39+
link: /
40+
- name: About
41+
link: /about/
42+
- name: Posts
43+
link: /posts/
44+
- name: Contact
45+
link: /contact/
46+
```
47+
48+
This describes the navbar at the top of your site. If it is not present,
49+
there will be no links on your navbar. You can add or remove links here to
50+
customize your navigation.
51+
6. Build your site: `bundle exec jekyll serve`
3752
3853
Assuming there are no errors and the site is building properly, follow these
3954
steps next:
@@ -85,6 +100,7 @@ matter. Example:
85100
see how the files are set up.
86101
87102
<!-- TODO:
103+
88104
5. Add the form to the `contact.html` page. Add the following code to your
89105
`contact.html` page:
90106

0 commit comments

Comments
 (0)