Write basic content
Last updated
Last updated
is a way to write basic text content and formatting in a clean and simple way. Markdown .md
files are plain text files that get converted into .html
pages on your resulting website.
To an external site:
To a page within your site:
The example above works in most cases, because your site is likely to only have top-level pages and the URL is relative to the level of the current page. If you have sub-pages or more complex linking needs, see below.
The above section shows how you can write links as plain text content. But you will probably more often be linking to images/pages/whatever using the template's , , and . In these cases, links work slightly differently.
You can still link to an external, absolute URL, e.g. https://some-website.org/
. But if you are trying to link to something within your repo, the URL must start from the root of your repo, without any site name/"baseurl" prefix. You also cannot refer to files relative to the current file, or use the ..
to move up folders.
✓ GOOD
✘ BAD
With left-aligned, centered, and right-aligned columns.
With syntax highlighting.
The template comes with a few alignment utility classes:
Most things in the template are centered by default where appropriate, and left/right in a few other places where appropriate. But sometimes you may want to force the alignment of something.
For most purposes, prefer using the more richly featured (e.g. captions) and styled component instead.
In Markdown, you can attach an arbitrary class to an element with the syntax {:.class}
. Depending on the type of element, this code may have to go on the same line or on the next line.