Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
nakajima committed Apr 5, 2009
1 parent 2e214dc commit 73bc426
Showing 1 changed file with 40 additions and 8 deletions.
48 changes: 40 additions & 8 deletions README.md
@@ -1,13 +1,44 @@
# makers-mark
# Makers Mark(down)

@@@ ruby
def foo
:bar
end
@@@
Generate syntax highlighted HTML using [Markdown](http://daringfireball.net/projects/markdown/)/[Lighthouse](http://lighthouseapp.com/)
conventions. Good for stuff.

## Sounds good.
## Usage

Write something in [Markdown](http://daringfireball.net/projects/markdown/). Use the `mark` command to generate
the HTML:

$ mark some-file.md

### Syntax Highlighting

If you've used [Lighthouse](http://lighthouseapp.com/), you probably know how to post snippets
of code. This lets you do that as well:

# Some interesting code

Here it is:

@@@ ruby
def foo
:bar
end
@@@

## Todo

* The highlighting code is still a bit sketchy
* Ability to insert into a layout
* Other stuff...

## Credits

* Ryan Tomayko for RDiscount
* John Gruber for Markdown
* Chris Wanstrath for albino.rb
* Lighthouse for code snippet simplicity

<pre>
(c) Copyright 2009 Pat Nakajima

Permission is hereby granted, free of charge, to any person
Expand All @@ -29,4 +60,5 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
OTHER DEALINGS IN THE SOFTWARE.
</pre>

0 comments on commit 73bc426

Please sign in to comment.