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
If you find a mistake or wish to make an improvement to these pages, you can do so. For a small mistake, just let us know by [contacting us](contacting-us). For other changes you can also access and edit the pages themself.
8
8
9
9
{% include callout.html type="important" content="
10
-
Note that FAIRDOM-SEEK instances are highly customisable.
11
-
This set of documentation pages can be customised for your local instance.
12
-
For example, they can be served at the root level or from within a directory.
13
-
Please contact your local instance admin for more information.
14
-
" %}
15
-
16
-
## Editing and adding pages
17
-
18
-
These pages can be found in GitHub at [https://github.com/seek4science/seek-documentation](https://github.com/seek4science/seek-documentation). Pages are in [Markdown](https://help.github.com/articles/markdown-basics/) format, with a _.md_ extension, but get converted into HTML for you.
19
-
New pages require a formatter at the top, that looks like:
20
-
```yaml
21
-
---
22
-
title: my lovely page
23
-
---
24
-
```
25
-
26
-
For example, this page can be found at [https://raw.githubusercontent.com/seek4science/seek-documentation/main/tech/contributing-to-pages.md](https://raw.githubusercontent.com/seek4science/seek-documentation/main/tech/contributing-to-pages.md).
27
-
28
-
The **home, about, user guide, and technical references pages** use a remote theme called [ELIXIR Toolkit Theme](https://elixir-belgium.github.io/elixir-toolkit-theme/) (ETT). The ETT theme provides additional support for styling and navigation, including the sidebar menus. The _title_ metadata is used to create a first-level heading at the top of the page. Do not include it again. Instead, use `##` and `###` for subheadings (second- and third-level, respectively).
29
-
30
-
The site can be served from a root domain/sub-domain (for example, `docs.site.com`) or from a directory (for example, `site.com/docs`). To support sites that are served from a directory, all links to pages within the site must be given as relative paths, not absolute paths. We use a [Jekyll filter](https://jekyllrb.com/docs/liquid/filters/) to achieve this, for example:
If you find a mistake or wish to make an improvement to these pages, you can do so. For a small mistake, just let us know by [contacting us](contacting-us). For other changes you can also access and edit the pages themself.
40
-
41
-
{% include callout.html type="important" content="
42
-
Note that FAIRDOM-SEEK instances are highly customisable.
10
+
Note that FAIRDOM-SEEK instances are highly customisable.
43
11
This set of documentation pages can be customised for your local instance.
44
12
For example, they can be served at the root level or from within a directory.
45
13
Please contact your local instance admin for more information.
@@ -93,34 +61,3 @@ and then goto [localhost:4000](http://localhost:4000). For more information plea
93
61
## Committing your changes
94
62
95
63
You can make a change by forking and issuing a pull request. If contributing through GitHub is unfamiliar to you, please read [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/).
96
-
97
-
98
-
All links to images within the site must also be given as relative paths (with alt description), for example:
99
-
```
100
-
{% raw %}{:.screenshot}{% endraw %}
101
-
```
102
-
103
-
To add your new page to the sidebar, add a line to the data file:
104
-
`_data`►`sidebars`►`userguide.yml`, `tech.yml` or `about.yml`.
105
-
More details are available from the [ETT theme documentation](https://elixir-belgium.github.io/elixir-toolkit-theme/navigation_structures).
106
-
107
-
The **about pages** (top level) require additional lines at the top to display correctly:
108
-
```yaml
109
-
---
110
-
sidebar: about
111
-
---
112
-
```
113
-
## Viewing your changes locally
114
-
115
-
If you want to view your changes as you edit them, with Ruby installed you can install and run Jekyll with:
116
-
117
-
```sh
118
-
gem install bundler
119
-
bundle install
120
-
bundle exec jekyll serve
121
-
```
122
-
and then goto [localhost:4000](http://localhost:4000). For more information please see [Using Jekyll with Pages](https://help.github.com/articles/using-jekyll-with-pages/).
123
-
124
-
## Committing your changes
125
-
126
-
You can make a change by forking and issuing a pull request. If contributing through GitHub is unfamiliar to you, please read [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/).
0 commit comments