| title | layout | sidebar | permalink |
|---|---|---|---|
Contributing to these pages |
page-ett |
tech |
/contributing-to-pages |
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. For other changes you can also access and edit the pages themself.
These pages can be found in Github at https://github.com/seek4science/seek-documentation. Pages are in Markdown format, with a .md extension, but get converted into HTML for you. New pages require a formatter at the top, that looks like:
---
title: my lovely page
layout: page-ett
---
For example, this page can be found at https://raw.githubusercontent.com/seek4science/seek-documentation/main/contributing-to-pages.md.
The top level, technical reference, user guide pages use a remote theme called 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).
To add your new page to the sidebar, add a line to the data file:
_data ► sidebars ► userguide.yml, tech.yml or about.yml.
More details are available from the ETT theme documentation.
The about pages (top level) require additional lines at the top to display correctly:
---
permalink: /path-of-page
sidebar: about
---
If you want to view your changes as you edit them, with Ruby installed you can install and run Jekyll with:
gem install bundler
bundle install
bundle exec jekyll serve
and then goto localhost:4000. For more information please see Using Jekyll with Pages.
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.