From 862c9ccebe20a00d6d2f9a846b11e5b90349541d Mon Sep 17 00:00:00 2001 From: atteggiani Date: Thu, 2 May 2024 11:52:35 +1000 Subject: [PATCH] Updated README --- README.md | 41 ++++++++++++++++++++++++++--------------- 1 file changed, 26 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 780aab013..9c02f7a6d 100644 --- a/README.md +++ b/README.md @@ -23,29 +23,21 @@ Please follow the guidelines below to make the Hive consistent among all the pag - Code lines/blocks need to be used for lines/blocks of code, terminal commands and file/directory paths/names; - Italic needs to be used when referring to specific proper nouns (for example _Gadi_ or _payu_); - Bold can be used to highlight some words (please do not overuse it); -<<<<<<< HEAD -<<<<<<< HEAD -- To signal an important note within the text, consider using a "warning note" (see HTML cheatsheet below); -- Instructions for different versions (for example different operative systems or different model versions) can be rendered using tabs (see HTML cheatsheet below); -======= -- All types of admonitions (info, warning, etc.), collapsible and not, can be used as described in the [documentation](https://squidfunk.github.io/mkdocs-material/reference/admonitions/), but they are rendered slightly differently. For the HTML version of them, please refer to the [HTML/Markdown cheatsheet](#HTML/markdown-cheatsheet). -- Instructions for different versions (for example different operative systems or different model versions) can be rendered using tabs (see [HTML/Markdown cheatsheet](#HTML/markdown-cheatsheet)); ->>>>>>> davide/review-PR-OM2 -======= -- All types of admonitions (info, warning, etc.), collapsible and not, can be used as described in the [documentation](https://squidfunk.github.io/mkdocs-material/reference/admonitions/), but they are rendered slightly differently. For the HTML version of them, please refer to the [HTML/Markdown cheatsheet](#HTML/markdown-cheatsheet). -- Instructions for different versions (for example different operative systems or different model versions) can be rendered using tabs (see [HTML/Markdown cheatsheet](#HTML/markdown-cheatsheet)); ->>>>>>> development +- All types of admonitions (info, warning, etc.), collapsible and not, can be used as described in the [documentation](https://squidfunk.github.io/mkdocs-material/reference/admonitions/), but they are rendered slightly differently. For the HTML version of them, please refer to the [HTML/Markdown cheatsheet for the Hive](#cheatsheet). +- Instructions for different versions (for example different operative systems or different model versions) can be rendered using tabs (see [HTML/Markdown cheatsheet for the Hive](cheatsheet)); +- Terminal input/output examples can be rendered using [animated-terminal.js](https://github.com/atteggiani/animated-terminal.js) ### Styling Markdown using CSS #### Attribute lists -To style Markdown using custom CSS, you can use [attribute lists](https://python-markdown.github.io/extensions/attr_list/#limitations) by adding the desired CSS style (in-line or adding classes as defined in the `access-nri.css` file) inside curly brackets (starting with a comma) right after the markdown syntax. +To style Markdown using custom CSS, you can use [attribute lists](https://python-markdown.github.io/extensions/attr_list/#limitations) by adding the desired CSS style (in-line or adding classes as defined in the `access-nri.css` file) inside curly brackets (starting with a colon) right after the markdown syntax. For example, to make an image 50%-wide and with rounded borders, you can write the following: ``` ![image text](/image/url/){: style="width: 50%; border-radius: 0.6rem;" } ``` #### Markdown in HTML -You can use [Markdown in HTML](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=md+in+html#markdown-in-html) by adding the `markdown` attribute inside an HTML tag.
You can then style the HTML tag using CSS (in-line or adding selectors to the `access-nri.css` file). +You can use [Markdown in HTML](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/?h=md+in+html#markdown-in-html) by adding the `markdown` attribute inside an HTML tag.
+You can then style the HTML tag using CSS (in-line or adding selectors to the `access-nri.css` file). For example, to render a markdown section with half font-size, you can write the following: ``` @@ -57,7 +49,26 @@ For example, to render a markdown section with half font-size, you can write the ``` -### HTML/Markdown Cheatsheet for the Hive +### Custom HTML tags +Some custom HTML tags were created (in the `js/custom-tags.js`) to facilitate the rendering of some components.
+The following custom tags are available: + +- "Not supported by ACCESS-NRI" admonition
+ The `` tag renders a preset "Not supported by ACCESS-NRI" admonition. +- References
+ The ` ... ` tag renders references to be used at the bottom of a page. Each reference inside `...` should be a link preceded by a hyphen (`-`) and will be treated as a separate bullet point. Spaces between different references will be disregarded for the rendering.
+ For example, to reference 2 links you can write: + ``` + + - [First reference](first-reference-url) + - [Second reference](second-reference-url) + + ``` +- Simulated terminal info
+ The tag renders a preset info admonition on the pages where simulated terminal are used. It should not be used manually as it is automatically embedded in the pages containing simulated terminals. + + +### HTML/Markdown Cheatsheet for the Hive{: id="cheatsheet" } |Style|Markdown Syntax|HTML Syntax|Rendered example| |---|---|---|---| |**Bold**|\*\*bold**|\bold\|**bold**|