add docs + bugfix

ELIXIR-Belgium · Aug 23, 2024 · d7cf9ff · d7cf9ff
1 parent 57062d3
commit d7cf9ff
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/_layouts/page.html b/_layouts/page.html
@@ -1,7 +1,7 @@
 ---
 layout: default
 ---
-<main id="main" class="order-1 add-grid">
+<main id="main" class="order-1{% unless page.toc == false %} add-grid{% endunless %}">
     <div id="intro">
         {%- if page.title %}
         {%- if page.type %}

diff --git a/pages/documentation/page_mechanics.md b/pages/documentation/page_mechanics.md
@@ -35,7 +35,7 @@ It is important to know that you can also set the these key-value pairs on multi
 
 * `sidebar`: Specify here an alternative sidebar, which corresponds to the filename in the *_data/sidebars/* directory. Default: *main*. If no sidebar is set, or *sidebar: false*, no sidebar will be shown.
 
-* `toc`: When set to false, the table of contents in the beginning of the page will not be generated.
+* `toc`: When set to *false*, the table of contents at the right side of the page will not be generated. This is recommended when you know in advance no table of contents will ever be needed, and improves page loading times.
 
 * `page_id`: Unique identifier of a page used to list Related pages or to tag tools in the *tool_and_resource_list.yml* file. It is usually a shortened version of the page name or title, with small letters, or an acronym, with capital and small letters. Make sure it does not contain hyphens if you want to make use of the Tools and resources table. .
 
@@ -93,6 +93,13 @@ It is important to know that you can also set the these key-value pairs on multi
   dsw_deep_link_prefix: https://researchers.ds-wizard.org/knowledge-models/dsw:root:latest/preview?questionUuid=
   ```
 
+* `rdmkit`: Link out to guides inside of the RDMkit.
+  ```yml
+  rdmkit:
+    - name: RDMkit page title
+      url: https://rdmkit.elixir-europe.org/human_data
+  ```
+
 ### Tools and resources
 
 * `ref_to_main_resources`: Refer to entries of the "main_tool_ and_resource_table" if institutions, organizations and projects from the country contribute to the development of international tools and resources. List the id of the tool your refer to in the main tools table.

diff --git a/pages/example_pages/overview_tiles.md b/pages/example_pages/overview_tiles.md
@@ -1,5 +1,6 @@
 ---
 title: Overview page example
+toc: false
 ---
 
 More info about sections tiles can be found in the [website sections page](website_sections).