Giter Club home page Giter Club logo

marshmellow's Introduction

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

marshmellow's People

Contributors

audreylim avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.