A Markdown Renderer for the BlackFriday library

blackfriday-renderer markdown

2.2 KiB

Raw Permalink Blame History

An h1 header

Paragraphs are separated by a blank line.

2nd paragraph. Italic, bold, monospace. Itemized lists look like:

this one
that one
the other one

Nothing to note here.

Block quotes are written like so.

They can be nested.

They can span multiple paragraphs, if you like.

Item 1
Item 2
- Item 2a
  - Item 2a
- Item 2b
Item 3

Hmm.

Item 1
Item 2
1. Blah.
2. Blah.
Item 3
- Item 3a
- Item 3b

Large spacing...

An entire paragraph is written here, and bigger spacing between list items is desired. This is supported too.
Item 2
1. Blah.
2. Blah.
Item 3
- Item 3a
- Item 3b

Last paragraph here.

An h2 header

Paragraph right away.
Big item: Right away after header.

Visit GitHub!

~~Mistaken text.~~

This (should be fine).

A > B.

It's possible to backslash escape <html> tags and `backticks`. They are treated as text.

1986. What a great season.

The year was 1986. What a great season.

*literal asterisks*.

http://example.com

Now a link in a paragraph. End with link_underscore.go.

Link

An h3 header

Here's a numbered list:

first item
second item
third item

By the way, instead of indenting the block, you can use delimited blocks, if you like:

define foobar() {
    print "Welcome to flavor country!";
}

(which makes copying & pasting easier). You can optionally mark the delimited block for Pandoc to syntax highlight it:

func main() {
	println("Hi.")
}

Nested Lists

Codeblock within list

list1
```
if (i == 5)
  break;
```

Blockquote within list

list1

This a quote within a list.

Multi-level nested

Item 1

Another paragraph inside this list item is indented just like the previous paragraph.
Item 2
- Item 2a
  
  Things go here.
  
  This a quote within a list.
  
  And they stay here.
- Item 2b
Item 3

Line Breaks

Some text with two trailing spaces for linebreak.
More text immediately after.
Useful for writing poems.

Done.

2.2 KiB Raw Permalink Blame History