Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 3.32 KB

TESTDOC.md

File metadata and controls

101 lines (63 loc) · 3.32 KB

This example markdown doc is from http://www.markitdown.net/markdown :)

An exhibit of Markdown

This note demonstrates some of what Markdown is capable of doing.

Contents:

Basic formatting

Paragraphs can be written like so. A paragraph is the basic block of Markdown. A paragraph is what text will turn into when there is no reason it should become anything else.

Paragraphs must be separated by a blank line. Basic formatting of italics and bold is supported. This can be nested like so.

Lists

Ordered_list_time, oh yeah

  1. Item 1
  2. A second item
  3. Number 3

Note: the fourth item uses the Unicode character for Roman numeral four.

Unordered list

  • An item
  • Another item
  • Yet another item
  • And there's more...

Paragraph, modifiers?

Code block!!

Code blocks are very useful for developers and other people who look at code or other things that are written in plain text. As you can see, it uses a fixed-width font.

You can also make inline code to add code into other things.

Quote^whoa!

Here is a quote. What this is should be self explanatory. Quotes are automatically indented when they are used.

Headings

There are six levels of headings. They correspond with the six levels of HTML headings. You've probably noticed them already in the page. Each level down uses one more hash character.

Of course, demonstrating what headings look like messes up the structure of the page.

I don't recommend using more than three or four levels of headings here, because, when you're smallest heading isn't too small, and you're largest heading isn't too big, and you want each size up to look noticeably larger and more important, there there are only so many sizes that you can use.

URLs

URLs can be made in a handful of ways:

Horizontal rule

A horizontal rule is a line that goes across the middle of the page.


It's sometimes handy for breaking things up.

Examples & more examples!

Images

Markdown can also contain images. I'll need to add something here sometime.

Sub-heading example

Finally

There's actually a lot more to Markdown than this. See the official introduction and syntax for more information. However, be aware that this is not using the official implementation, and this might work subtly differently in some of the little things.