0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Given a markdown formated text, transforms it to html via a simple method `simple_markdown`
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.3.10

Runtime

>= 4.2.0
 Project Readme

Gem Version Build Status Coverage Status Code Climate

SimpleMarkdown

This project rocks and uses MIT-LICENSE.

Note : does not provide an exhaustive markdown parser. It is intended only to give the most simple and usefull syntax, so as to keep it simple (stupid?).

Installation

# Gemfile
source 'https://rubygems.org'
gem 'simple_markdown'

Then run bundle install.

Can also do gem install simple_markdown

Features

  • Titles with
# Title 1
## Title 2
...
###### Title 6
  • List with (only)
* Apple
* Banana
  • Emphasis with
This is *emphasis* test
  • Bold with
This is **bold test**
  • Image with
This is an image : [description](http://example.com/im.png)
  • Link with
This is a ![link](http://example.com)

Special non-markdown, consider it as an extra DSL

I aded the ability to make horizontal blocks.

  • Two horizontal block with (specify the number of block in the first tag)
[2-flex]

This is the flex block number one, with
* a list

[flex]

This is the flex block number two
\```
a code block (backticks escaped with '\')
\```

[flex]

Normal paragraph, not in block.
  • You can specify the width of each block, relative to the other ones
[2-flex-4]

This block n°1 has 4/5th of the width

[flex-1]

This block n°2 has 1/5th of the with

[flex]
  • center content with
->Centered text<-
->

# Centerd title

<-