Skip to content

MohawkRaphaelT/markdown-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 

Repository files navigation

Heading 1

This is just some regular text! No special characters needed to make a paragraph.

Heading 2

We made another heading, but with two ##. See how # is only interpreted as a heading if it is the first character on a new line?

Heading 3

And so we can keep going. Also, did you notice that text with a space between lines gets combined on GitHub?

Emphasis

italic

bold

bold and italic

Lists

Ordered List

  1. Ready
  2. Set
  3. Go!

Unordered List

  • Ready
  • Set
  • Go!

Contextual Text Formats

Blockquote (single line)

This is a block quote

Blockquote (multiple lines)

Rule of thumb: if you think something is clever and sophisticated beware-it is probably self-indulgence.

- Don Norman

Code

This is a snippet of code

Code Block

// This is a C# code block
while(true)
{
  Console.WriteLine("Hello, world!");
}

Hyperlinks

For a simple hyperlink, just past it.

https://en.wikipedia.org/wiki/Game

For named hyperlinks, use this format: [text](url)

Super secret hyperlink

Media

Link to media, using ![text](path/to/media)

We can use relative (local to repository) or absolute (full, typically for URL) paths to media files.

Absolute Path

Useful for linking to media via URLs.

Image of very old game

Relative Path

Here's some media in this GitHub repository.

TBD relative img

Broken Link

When media cannot be found, it'll look like this (link intentionally missing extension .jpg).

Image of very old game

Dividers

Some text.


Divided!


Divided once more!


And yet again!

Colours

Mardkown does not natively support text color. If you really need it, you must use HTML syntax. However, GitHub tends to strip out HTML.

Red text.

Escape Sequence

Use \ if you need a character but it gets interpreted as Markdown.

# Not a heading

*not bold*

About

Example use of Markdown formatting.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors