Skip to content

Commit

Permalink
prep 1.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
geraldb committed May 25, 2013
1 parent aa849c7 commit 653a62c
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 14 deletions.
46 changes: 33 additions & 13 deletions README.markdown
Expand Up @@ -17,6 +17,7 @@ your markdown library of choice. Preconfigured markdown libraries include
* `rdiscount`
* `pandoc-ruby`


## Usage - Ruby Code

require 'markdown'
Expand All @@ -26,25 +27,44 @@ your markdown library of choice. Preconfigured markdown libraries include
# => "<p>Hello World</p>\n"


## Usage - Web Service / HTTP (JSON) API - `GET /markdown`

Try the `markdown` HTTP (JSON) API running
on Heroku [`hypertext.herokuapp.com`](http://hypertext.herokuapp.com).

Example:

GET /markdown?text=Hello+World!

<p>Hello World!</p>


To start your own server/service use `markdown serve`. See command line below.


## Usage - Command Line

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
and preprocessing text filters.
Usage: markdown [options] files_or_dirs
-o, --output PATH Output Path
-v, --verbose Show debug trace

markdown - Lets you convert plain text documents to hypertext with your Markdown engine of choice
and preprocessing text filters.

Usage: markdown [options] files_or_dirs
-o, --output PATH Output Path
-v, --verbose Show debug trace


Examples:
markdown # Process all documents in working folder (that is, .)
markdown quickref # Process document or folder using Markdown
markdown quickref.text # Process document using Markdown
markdown -o site quickref # Output documents to site folder

Note:
markdown server # Starts builtin markdown server
# (aliases for server include serve, service, s)

Examples:
markdown # Process all documents in working folder (that is, .)
markdown quickref # Process document or folder using Markdown
markdown quickref.text # Process document using Markdown
markdown -o site quickref # Output documents to site folder
```

## Configuration - Markdown Engine Loading Order

Expand Down
3 changes: 2 additions & 1 deletion lib/markdown/cli/runner.rb
Expand Up @@ -150,7 +150,8 @@ def run( args )
markdown -o site quickref # Output documents to site folder
Note:
markdown server # Starts builtin markdown server (alias for server include serve, service, s)
markdown server # Starts builtin markdown server
# (aliases for server include serve, service, s)
Further information:
Expand Down

0 comments on commit 653a62c

Please sign in to comment.