Skip to content

formatting.md

Latest commit

 

History

History
179 lines (117 loc) · 4.27 KB

formatting.md

File metadata and controls

179 lines (117 loc) · 4.27 KB
Raw

Markdown formatting

Pictures

This displays a different image depending on light/dark theme

YOUR-ALT-TEXT

Replace your-darkmode-image and your-lightmode- image with image URLs. Replace your-alt-text with description of images for use with a screen reader.

Shows an illustrated sun in light mode and a moon with stars in dark mode.

This is a responsive image.

Adding a Table

This is a header

Rank Thing-to-rank
1
2
3

Collapsed section

To add a collapsed section, i.e. the above table, wrap the table in details section:

My table

This is a header

Rank Thing-to-rank
1
2
3

To make it open by default add the open attribute to the details tag.

Adding a quote

If we pull together and commit ourselves, then we can push through anything.

— Mona the Octocat

Adding a comment

About me

Headings

Second level heading

Third level heading

Styling text

This is bold text
This is bold text as well
Some italic text
This works as well
The Tilde will strike through
Bold and nested italics
This is bold AND italics
We can also do subscript text
And also superscript!!!

Quoting code

Use back ticks to quote code:

Use git status to list all new or modified files that haven't yet been committed

To put it into blocks use triple back ticks:

Some basic Git commands are:

git status
git add
git commit

Colours!!

The background color is #ffffff for light mode and #000000 for dark mode.

Links

Wrap the text in a bracket to create a link:

This site was built using GitHub Pages

Lists

  • Tom
  • Dick
  • Harry

Any of those precursors will work.

  1. Tom
  2. Dick
  3. Harry

Or you can number them!

If you really want to be clever, you can nest them!

  1. First
    1. First nested
    2. Something else
      1. Another nest!
  2. Second item
    1. Second first nest
      2. Another nest again!
      3. Stuff.

Use four spaces or some tabs to create the nests, eight for a second nest. Two spaces are needed at the end for a new line.

Task list

Paragraphs

You can create a new paragraph by leaving a blank line between lines of text.

Footnotes

Here is a simple footnote1.

A footnote can also have multiple lines2.

Alerts

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

Hiding in comments

Ignoring markdown formatting

Let's rename *our-new-project* to *our-old-project*.

put the stuff in slash asterisk to ignore formatting.

Footnotes

  1. My reference. ↩

  2. To add line breaks within a footnote, prefix new lines with 2 spaces. This is a second line. ↩