Conventions
Conventions used within the recipes
These are the types of boxes available to provide additional information along the main content of the recipe:
Boxes
This is a supplementary piece of information
This is a tip to help you running any tool or pipeline
This is how the console output should look like
This is a warning about a potential problem
These are directory contents
This is an explanation about a common bug/error
This is a piece of code
This is a link to external learning material
This is to reference to a specific person or group
This is to clarify the applicable license
This to give credit to someone
Code
This how commands to run in the terminal looks like:
run anytool -parameters
This is how to display the content of a given script with a highlight in specific line:
| hello-world.py | |
|---|---|
1 2 3 | |
This is how to display the code in a given script before and after of making any modification:
| hello-world.py | |
|---|---|
1 2 3 | |
| hello-world.py | |
|---|---|
1 2 3 | |
Images
This is how to place images within the recipe:
