Skip to content

Commit 7049e46

Browse files
authored
Merge pull request #400 from ELIXIR-Belgium/add-type_img
Add `type_img` attribute to page mechanics documentation
2 parents 1fd8408 + f353e0c commit 7049e46

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

pages/documentation/page_mechanics.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ It is important to know that you can also set the these key-value pairs on multi
4747

4848
* `type`: The type of page, used for [website sections](website_sections). Case the value is case sensitive and spaces should get replaced with underscores.
4949

50+
* `type_img`: Specify an icon that is shown in front of the page title in the section navigation tiles (See [Website sections](website_sections)) and related pages. It can be used as a "Section" specific icon to visually group.
51+
5052
* `page_citation`: When set to true, it will cause the citation section for the page to be generated in the format: `<author names>. <page title>. <site domain>. <page URL>. <date accessed>.`
5153

5254
### Page specific GitHub configurations

pages/documentation/website_sections.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ title: Website sections
44

55
When content grows, the need to categorize grows. The theme makes it possible to categorize in the [sidebar](navigation_structures#sidebar), but also to list pages in a nice way that belong to the same section.
66

7-
A section is simple a collection of pages of the same `type`, see [page mechanics](page_mechanics). Adding the pages you want to list in an overview, can be simply done by tagging them with a type (in the example `type: Example_pages`) in the [page metadata](page_mechanics) and listing that type using the snippets below. Be aware that the type attribute is case sensitive and spaces should get replaced with an underscore "_".
7+
A section is a collection of pages of the same `type`, see [page mechanics](page_mechanics). Adding the pages you want to list in an overview, can be done by tagging them with a type (in the example below `type: Example_pages`) in the [page metadata](page_mechanics). If you do not want to list pages using their type, you can also manually list them using the `custom` parameter and listing the `page_id`s in a comma separated way. Be aware that the type attribute is case sensitive and spaces should get replaced with an underscore "_".
8+
9+
{% include callout.html type="tip" content="Use the `type_img` attribute to specify a section/type icon as seen in the *General page example 2* tile." %}
810

911

1012
## Section tiles with information

0 commit comments

Comments
 (0)