Markdown Syntax

---

Our website is created from markdown files by mkdocs. On top of the general markdown syntax, this page will detail the additional syntax available.

Plugin enabled syntax

admonition

source: mkdocs-material theme

• Documentation

• types

attr_list

source: mkdocs-material theme

• Documentation

def_list

source: mkdocs-material theme

• Documentation

meta

source: mkdocs-material theme

• Documentation

Supports adding a yaml header to markdown documents containing metadata.

pymdown-extensions

• Docs

pymdownx.details

Creates collapsible elements.

<details>

<summary>a title goes here</summary>

this is the content that you wish to collapse
</details>

Demo:

---

a title goes here

this is the content that you wish to collapse

---

pymdownx.superfences

• Content Tabs Documentation

enables content to be placed in tabbed areas.

pymdownx.tabbed ToDo:ENABLE ME

markdown_extensions:
  - pymdownx.tabbed:

pymdownx.tasklist

• Documentation

Create markdown task lists

- [ ] a task list item

    - [ ] sub task list item

- [ ] second task list item

Demo

---

• a task list item

  • sub task list item

• second task list item

---

Code Blocks

• docs https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
• Code block snippets https://facelessuser.github.io/pymdown-extensions/extensions/snippets/

code blocks can use a file as the contents of the codeblock. to do this use the relative path of the file, referencing the repositoy root directory as the base path.

Including an external file in a code block

;``` yaml title="Including an external file in a code block"
;--8<-- 
;website-template/mkdocs.yml
;--8<--

or

;--8<-- "website-template/mkdocs.yml"
;```

NOTE: Dont include the ; in the codeblock. they exist here so that the code displays for the example.

to add line number use linenums="1" on the opening of the code block

to add a title use title=".gitlab-ci.yml" on the opening of the code block

About:

This page forms part of our Operations Manual.

Page Metadata

Version: ToDo: place files short git commit here
Date Created: 2022-08-25
Date Edited: 2023-05-27

Contribution:

Would You like to contribute to our Operations Manual? You can assist in the following ways:

• Edit This Page If there is a mistake or a way you can improve it.
• Add a Page to the Manual if you would like to add an item to our manual
• Raise an Issue if there is something about this page you would like to improve.

 

ToDo: Add the page list of contributors