Markdown processor written in Go.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
marshmellow
README.md
parser.go
parser_test.go
scanner.go
scanner_test.go
token.go

README.md

Marshmellow

Marshmellow is a simple markdown processor implemented in Go.

Installation

go get github.com/audreylim/marshmellow/...

Usage

Conversion can be done on multiple files. Just run

$GOPATH/bin/marshmellow file1.md file2.md file3.md

This turns the markdown files into corresponding HTML files, ie. file1.html, file2.html, file3.html.

Syntax

Marshmellow currently supports the following syntax:

Headers
# Header 1

becomes

<h1>Header 1</h1>

Marshmellow supports up to h6 headers, ie. ###### Header 6.

Paragraph
Paragraph 1

becomes

<p>Paragraph 1</p>
Bold
**Bold Text**

becomes

<b>Bold Text</b>
Italics
*Italic Text*

becomes

<i>Italic Text</i>
Bullets
* Bullet 1
* Bullet 2
* Bullet 3

becomes

<ul>
<li>Bullet 1</li>
<li>Bullet 2</li>
<li>Bullet 3</li>
</ul>

License

MIT