Posted over 8 years ago. Visible to the public.

Markdown/Commonmarker examples

This card shows you how to format a card's content using Markdown. We use the Commonmarker interpreter, so here are examples for its dialect.

Formatting

Copy
**Bold**

Bold

Copy
_Italics_

Italics

Copy
`Monospaced`

Monospaced

Copy
> Quoted text

Quoted text

Copy
Here is [a link](http://makandra.com/).

Here is a link.

Copy
![An image; this is the alt text](http://www.makandra.com/assets/logo/makandra-logo-home.png)

An image; this is the alt text

Line breaks

Copy
A line break in the code results in a line break. Add a new line for a paragraph.

A line break in the code
results in a line break.

Add a new line for a paragraph.

Headlines

Underline headlines with an equals sign or dash -- or start a line with a hash symbol:

Copy
Hello World ----------- Lorem ipsum... Hello Universe ============== Lorem ipsum... # Hello Alice Lorem ipsum...

Hello World

Lorem ipsum...

Hello Universe

Lorem ipsum...

Hello Alice

Lorem ipsum...

Horizontal rules

Just draw a line with dashes. Make sure to have a blank line above it so it's not interpreted as a headline.

Copy
Here is some text. ------------------------ Text below the horizontal rule.

Here is some text.


Text below the horizontal rule.

Code

Indent text by 4 spaces. This way it is recognized as code.

Copy
def foo "hello!" end
Copy
def foo "hello!" end

You can also create code blocks GitHub-style:

Copy
``` def foo "hello!" end ```
Copy
def foo "hello!" end

Lists

Copy
* Bullet list item 1 * Bullet list item 2
  • Bullet list item 1
  • Bullet list item 2

You can also use + or - instead of *.

Copy
1. Numbered list item 2. Numbered list item 42. You don't need to number properly
  1. Numbered list item
  2. Numbered list item
  3. You don't need to number properly

(Mind 42 not being used; counting happens automatically)

Combining

You can of course combine this. It becomes a bit tricky when you're using lists, but it's not that hard. Just make sure you indent properly (2 spaces for bullet/definition lists, 3 spaces for numbered lists [since you have number + dot + space]).

Copy
* This is a list * Sub item 1 * Sub item 2 * Next list item. We can also nest code: def foo "hello!" end ... and continue writing. This still is part of the list item.
  • This is a list

    • Sub item 1
    • Sub item 2
  • Next list item. We can also nest code:

    Copy
    def foo "hello!" end

    ... and continue writing. This still is part of the list item.

makandra has been working exclusively with Ruby on Rails since 2007. Our laser focus on a single technology has made us a leader in this space.

Owner of this card:

Avatar
Arne Hartherz
Last edit:
28 days ago
by Niklas Hasselmeyer
About this deck:
We are makandra and do test-driven, agile Ruby on Rails software development.
License for source code
Posted by Arne Hartherz to makandra dev
This website uses cookies to improve usability and analyze traffic.
Accept or learn more