Tutorial video:

Download Markdown File

Open this file in Typora

This is where you can see what the markdown looks like and can toggle back and forth between markdown and code by using Ctrl + /.

Add — then hit enter- this is where front matter goes, for example the “title: “, which is case sensitive and needs a :

You can also add weights if you would like the pages to show up in the sidebar in a certain order- 1 being first, etc:

weight: 1







###You need to add a space after the # #

Adding Emphasis

Emphasis, aka italics, with asterisks or underscores.

Strong emphasis, aka bold, with asterisks or underscores.

Combined emphasis with asterisks and underscores.

Strikethrough uses two tildes. Scratch this.

Use [ ] for text of the link, what people will see, ( ) for the actual link

What you want to say here

Go to Google! et-al page

Posting pictures

! [Image name goes here] (filepath of where the image is)


If you want your image to have text appear other than the image name you can add “ “ after the file path and that will be what shows up when people hover over the image:


The filepath of the image needs to be in the docs/assets/images folder in the repository you are working in on github. If these don’t exist you need to create them. /documentation references the docs folder in the repository you are in- pyBRAT, RCAT, etc. The filepath is critical.


If you want to show code add ` around the code:

print: "Hello World."


If you want to embed a youtube video (or Google Map or something else), you can go click on the share and then embed buttons, then copy the code and paste it:

Here is a markdown cheatsheet that has more information if you are looking for more.