Skip to content

Latest commit

 

History

History
145 lines (99 loc) · 2.68 KB

docs_md_test.md

File metadata and controls

145 lines (99 loc) · 2.68 KB

Markdown examples

H1

H2

H3

H4

Emphasis

Emphasis, aka italics, with asterisks.

Strong, aka bold, with double asterisks

Strong with emphasis, triple asterisks

Code

inline code with backticks

indented code
for blocks even in XML

XML code with HTML below

textarea

<textarea disabled readonly cols="100%" style="resize: none"> </textarea>

pre

    
    

triple backtick code block

    some code
    more code

Even XML

    <configuration>
        <property>
        </property>
    </configuration>

XML Example

<note>
<to>Tove</to>
<from>Jani</from>
<heading>Reminder</heading>
<body>Don't forget me this weekend!</body>
</note>

XML as a codeblock example

<note>
  <to>Tove</to>
  <from>Jani</from>
  <heading>Reminder</heading>
  <body>Don't forget me this weekend!</body>
</note>

#Lists

Github style with leading space-dash

  • first UL item
  • second UL item

and space-number

  1. first point
  2. second point

(In this example, leading and trailing spaces are shown with with dots: ⋅)

  1. First ordered list item
  2. Another item
    • Unordered sub-list.
  3. Actual numbers don't matter, just that it's a number
    1. Ordered sub-list
  4. And another item.

After some intervening text we can do unordered lists again.

  • Unordered list can use asterisks
  • Or minuses
  • Or pluses

Links

There are two ways to create links.

I'm an inline-style link

I'm an inline-style link with title

I'm a reference-style link

I'm a relative reference to a repository file

You can use numbers for reference-style link definitions

Or leave it empty and use the link text itself.

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or http://www.example.com and sometimes example.com (but not on Github, for example).

Some text to show that the reference links can follow later.

Images

Relative image src from /docs/images/md.jpeg

Here's our logo (hover to see the title text):

Inline-style: alt text

Reference-style: alt text