This repository is the implementation of the ACCESS-Hive website accessible at the following URL:
https://access-hive.org.au/
ACCESS-Hive is the documentation hub for the Earth System models, ACCESS, and their community.
If you wish to add documentation to the ACCESS-Hive website check the contribution guide for instructions.
The ACCESS-Hive website is built using Material for MkDocs. For detailed information on markdown syntax and different features, please refer to mkdocs-material documentation.
Please follow the guidelines below to make the Hive consistent among all the pages contributed by different people.
/
which indicates the base website https://access-hive.org.au/
. So, a reference to the page https://access-hive.org.au/models/configurations/access-cm/
will be /models/configurations/access-cm
. Also, all assets need to be linked starting with /assets/...
. This because currently the link checker does not handle relative links properly.To style Markdown using custom CSS, you can use attribute lists 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;" }
You can use 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:
<div markdown style="font-size: 0.5em;">
### Section with half font-size (This will appear in the table of content)
- First _bullet_ point
- Second bullet **point**
</div>
Some custom HTML tags were created (in the js/custom-tags.js
file) to facilitate the rendering of some components.
The following custom tags are available:
"Not supported by ACCESS-NRI" admonition
The <custom-not-supported/>
tag renders a preset "Not supported by ACCESS-NRI" admonition.
References
The <custom-references> ... </custom-references>
tag renders references to be used at the bottom of a page. Each new line (created by pressing return/Enter) inside ...
is rendered as a separate bullet point. A hyphen (-
) can included at the beginning of a new line (for clarity) but it is stripped off at the time of rendering.
For example, to reference 2 links you can write:
<custom-references>
- [First reference](first-reference-url)
- [Second reference](second-reference-url)
</custom-references>
Simulated terminal info
The <custom-simulated-terminal-info/>
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.
Style | Markdown Syntax | HTML Syntax | Rendered example |
---|---|---|---|
Bold | **bold** | \bold\ | bold |
Italic | _italic_ | \italic\ | italic |
Code line | `code line` | \code line\ |
code line |
Code block | ``` code block ``` |
\
|
|
Admonition (not collapsible) | !!! warning this is a warning admonition |
\ this is a warning admonition \ |
![]() |
Collapsible Admonition | ??? warning title this is a collapsible warning admonition |
\ \
|
![]() |
Tabs | N/A | \ \ \ \ \ \ Content for tab1 \ \ Content for tab2 \ \ |
![]() |
The ACCESS-Hive site is covered by the CC-BY 4.0 license.
However, the material linked to from ACCESS-Hive is covered by various licensing agreements. Our users should directly refer to the terms and conditions of any material they are using to understand their rights and responsibilities.