Tutorial Editing
Tutorial pages are created with Markdown syntax similar to standard markdown or github-flavored markdown with a few notable extensions explained below.
These are "info-boxes" used for displaying important side content. There are 3 types: prereqs, info, and warning.
To use them, start a block with !!! followed by the type and a title enclosed in double quotes. The content of the block follows on the next line, indented by 4 spaces.
The prereqs callout is optional but should be placed at the very top of the tutorial and outlines what a user needs before following a tutorial (system requirements, knowledge, etc.). The content does not necessarily need to be an ordered or unordered list, it can be a simple paragraph as well.
Example:
!!! prereqs "Prerequisites"
1. Have [Docker](https://www.docker.com/) installed on your computer
2. Be familiar with `bash` or the linux shell
The info and warning callouts can be used anywhere on the page and are meant to display important information in a highlighted block.
Examples:
!!! warning "DANGER"
The `rm` command will permanently delete a file from your system. Use with caution.
!!! info "Note"
More information on the FAIR principles can be found [here](https://www.go-fair.org/fair-principles/)
Similar to how you can embed an image in markdown with , you are able to embed videos uploaded to Youtube or Vimeo with the same syntax. The regular video link (https://www.youtube.com/watch?... or https://vimeo.com/...) should be used instead of the embed link.
Example:
To insert a table of contents into the page use [TOC]. This is completely optional, however should be placed below the prereqs callout or at the top of the page if it does not exist. The table of contents indexes the sections in the page and produces anchor links to the headings. It is given the style float: right, meaning it will appear on the right of the page and the rest of the contents will wrap around it.
Example:
!!! prereqs "Prerequisites"
1. Have [Docker](https://www.docker.com/) installed on your computer
2. Be familiar with `bash` or the linux shell
[TOC]
# Main Section
Lorem ipsum dolor sit amet...
## 1. First sub-section
Sed ut perspiciatis unde omnis...
### a. Point A
### b. Point B
## 2. Second sub-section
# Second Main Section
TODO
TODO