Skip to content

Commit

Permalink
update readme cont.
Browse files Browse the repository at this point in the history
  • Loading branch information
geraldb committed Jun 10, 2012
1 parent 32fe445 commit d6d373c
Showing 1 changed file with 23 additions and 20 deletions.
43 changes: 23 additions & 20 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,27 @@

* [geraldb.github.com/markdown](http://geraldb.github.com/markdown)

## Description

The Markdown Engine Wrapper (`markdown`) Ruby gem lets you use
your markdown library of choice. Preconfigured markdown libraries include
`kramdown`, `redcarpet`, `bluecloth`, `maruku`, `rpeg-markdown`, `rdiscount`, `pandoc-ruby`.
your markdown library of choice. Preconfigured markdown libraries include

| `kramdown` | |
| `redcarpet` | |
| `bluecloth` | |
| `maruku` | |
| `rpeg-markdown` | |
| `rdiscount` | |
| `pandoc-ruby` | |

## Usage - Ruby Code
## Usage - Ruby Code

require 'markdown'

Markdown.new( 'Hello World' ).to_html


## Usage - Commandline
## Usage - Command Line

The `markdown` gem includes a little commandline tool. Try `markdown -h` for details:
The `markdown` gem includes a little command line tool. Try `markdown -h` for details:

```
markdown - Lets you convert plain text documents to hypertext with your Markdown engine of choice
Expand All @@ -35,33 +40,25 @@ Examples:
markdown -o site quickref # Output documents to site folder
```


## Install

Just install the gem:

$ gem install markdown


## Configuration - Markdown Engine Loading Order

The default (fallback) Markdown library is `kramdown`. To use your markdown engine of choice
configure the wrapper. The wrapper
uses the following lookup order to find the markdown engine:

### 1) `MARKDOWN_LIB` environment variable
### 1) `MARKDOWN_LIB` Environment Variable

Example:

set MARKDOWN_LIB=kramdown

### 2) `lib` property (in `./markdown.yml` or `~/markdown.yml`)
### 2) `lib` Property (in `./markdown.yml` or `~/markdown.yml`)

Example:

lib: kramdown

### 3) `libs` property (in `./markdown.yml` or `~/markdown.yml`)
### 3) `libs` Property (in `./markdown.yml` or `~/markdown.yml`)

Example:

Expand Down Expand Up @@ -91,9 +88,9 @@ You can also pass along options to your Markdown library. Example:
- strikethrough


## Filters (Commandline Only)
## Filters (Command Line Only)

For the commandline tool only you can configure preprocessing filters to
For the command line tool only you can configure preprocessing filters to
allow comments, Ruby helpers, and much more. Example:

## Let's use percent style comments
Expand Down Expand Up @@ -148,6 +145,12 @@ Example:
converter: pandoc-ruby-to-s5


## Install

Just install the gem:

$ gem install markdown


## Real World Usage

Expand Down

0 comments on commit d6d373c

Please sign in to comment.