Skip to content

Commit c290652

Browse files
committed
Update structure, reduce logo size
1 parent 53de93c commit c290652

File tree

3 files changed

+36
-9
lines changed

3 files changed

+36
-9
lines changed

index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This work is supported by the [Australian BioCommons](https://www.biocommons.org
3535

3636
This guide makes use of the [ELIXIR toolkit theme](https://github.com/ELIXIR-Belgium/elixir-toolkit-theme)
3737

38-
![](./assets/img/elixir-toolkit-theme_logo.svg)
38+
{% include image.html file="elixir-toolkit-theme_logo.svg" alt="Elixir Toolkit Theme logo" max-width="5em" %}
3939

4040
Ideas have also been drawn from other websites using this theme including:
4141
- [Infectious Diseases Toolkit](https://www.infectious-diseases-toolkit.org/)

pages/add_new_pages.md

+35-8
Original file line numberDiff line numberDiff line change
@@ -36,30 +36,57 @@ type: guides
3636
{:start="5"}
3737
5. Each new page that is included needs to be added to the `main.yml` file so that it appears in the left hand navigation menu.
3838

39-
An example of this code is provided below for the current How-to Guide:
39+
Below is the `main.yml` from the template repository:
40+
```yaml
41+
subitems:
42+
- title: Home
43+
url: /index
44+
- title: Example page
45+
url: /example_page
46+
- title: Contributors
47+
url: /contributors
48+
```
49+
50+
To create the guide you are currently viewing, this code was updated as follows:
4051

4152
```yaml
4253
subitems:
43-
- title: About
44-
url: /
54+
- title: Quick start
55+
url: /quick_start
4556
- title: 1. Create a new repository
4657
url: /create_new
4758
- title: 2. Update your landing page content
4859
url: /update_index
4960
- title: 3. Add new pages to your guide
5061
url: /add_new_pages
51-
- title: 4. Update configuration files
52-
url: /structure
53-
- title: 5. Test and improve your guide content
62+
- title: 4. Test & improve your guide content
5463
url: /improve_content
55-
- title: 6. Make your guide citable
64+
- title: 5. Make your guide citable
5665
url: /zenodo
57-
- title: Optional extra features
66+
- title: Adding optional features
5867
url: /extras
68+
- title: About
69+
url: /
70+
```
71+
72+
Note a few things:
73+
- The landing page url can be either `/index` or `/`
74+
- You can specify the order and structure of the navigation bar in `main.yml`
75+
- You can also add a title element and a link: this is shown below, with the `title_url` set to the landing page `index.md` for the guide
76+
77+
```yaml
78+
title: Navigation bar title
79+
title_url: /
80+
subitems:
81+
- title: Home
82+
url: /index
83+
- title: Example page
84+
url: /example_page
5985
- title: Contributors
6086
url: /contributors
6187
```
6288

89+
6390
There are many other options for configuring your guide web page differently and adding more complicated page and navigation structures. For more information please visit the [ELIXIR Toolkit theme documentation](https://elixir-belgium.github.io/elixir-toolkit-theme/).
6491

6592
{% include callout.html type="important" content="You will only need to modify the `_config.yml` if you wish to make major changes to the way your new guide repository makes use of the remote ELIXIR ToolKit theme. Instructions for how to do this, and what the different options are, can be [found here](https://elixir-belgium.github.io/elixir-toolkit-theme/configuring_theme). " %}

0 commit comments

Comments
 (0)