Markdown Tutorial

Published: July 31, 2023 at 12:00 AM

By: Amadeus Kirchoff

Markdown Tutorial

The following is a quick showcase of what you can do with markdown.

This text is on the next line because there is an empty line above it ^ The reason for the extra line is because it would be hard to write/read all of this in code if it was all in one line. This is written on multiple lines in the file, but doesn’t create any new lines in the post.

If you want more space between lines, write <br> (short for linebreak), and leave blank lines above and below it


To separate text with a line, you can use ---- in the same way as <br>


You can make text bold and italic and even bold and italic


The following are the different levels of heading sizes you can use:

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Links:

Clicking on this link will bring you to google.com

If you want to go to a page on this site, just write the last part of the url. For example, this link will bring you to the about page.


Usables:

To use components from the “usables” folder, you need to import it (at the top of the markdown content and beneath the front-matter) into the file.

If the usable requires some data, it’s easiest to create that in that script tag. Most usables should have a demonstration in the usables page.

Be aware that in markdown files, the variables need to be inside of “double quotes” when referenced like ingredients="{irishSodaBreadIngredients}"

(The purpose of the `backticks` in the markdown file is to make the compiler read this as text, not code here)


Then you can use it below like this:


Irish Soda Bread
Irish Soda Bread

Prep Time:

Cook Time:

Total Time: NaN

Yield:

Ingredients
Instructions
  1. Preheat oven to 375 degrees fahrenheit

  2. Mix all dry ingredients together in a bowl

  3. Mix all wet ingredients together in a separate bowl

  4. Combine together and stir

  5. Put in oven on middle rack for 30 minutes


More Info

This should cover most of the basics and if you ever need more information, please consult these guides here or here