Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

small readme

  • Loading branch information...
commit 4458b3dd6e94ecfd049d010a48891e0c5444b1db 1 parent 8181001
@alaz authored
Showing with 23 additions and 18 deletions.
  1. +23 −18 README.md
View
41 README.md
@@ -1,29 +1,34 @@
-Project
------
-This tiny project is aimed to investigate ways of processing of [Markdown][Markdown] markup
+## Project
+This tiny project is aimed to investigate ways of processing of [Markdown][] markup
language for Java projects. It was inspired by the article of Brian Carper
-["Clojure and Markdown (and Javascript and Java and...)"][clojure-js]
+["Clojure and Markdown (and Javascript and Java and...)"][clojs]
The project provides a trivial API to process Markdown markup based on three
implementations:
- - [MarkdownJ][markdownj] is a pure Java library
- - [Showdown][showdown] is a JavaScript implementation of Markdown, so it's possible to call
-it from Java using JavaScript implementations (this is the way Brian Carper proposed).
-I chose
- - [Mozilla Rhino][rhino] and
- - [Java6 Scripting][java6] (which is basically Rhino, but without
+* [MarkdownJ][] is a pure Java library
+* [Showdown][] is a JavaScript implementation of Markdown, so it's possible to call
+ it from Java using JavaScript implementations (this is the way Brian Carper proposed).
+ I chose
+ * [Mozilla Rhino][rhino] and
+ * [Java6 Scripting][java6] (which is basically Rhino, according to [this article][j6scripts])
-Benchmark
------
+### Benchmark
Along with the library you may find a simple benchmark comparing all three methods
described above. Do not trust absolute numbers blindly, as every run does Markdown
source processing, transformation to XML and then compares resulting XML to the
reference one.
- [Markdown]: http://daringfireball.net/projects/markdown/
- [clojure-js]: http://briancarper.net/blog/clojure-and-markdown-and-javascript-and-java-and
- [markdownj]: http://code.google.com/p/markdownj/
- [showdown]: http://attacklab.net/showdown/
- [rhino]: http://www.mozilla.org/rhino/
- [java6]: http://java.sun.com/javase/6/docs/api/javax/script/package-summary.html
+#### Special note for Apple VM
+If you have trouble running JavaScript engine in Java6 under Mac OSX,
+["How to include JavaScript engine in Apple's Java 6 VM"][applejvm] has a good
+recipe.
+
+[markdown]: http://daringfireball.net/projects/markdown/
+[clojs]: http://briancarper.net/blog/clojure-and-markdown-and-javascript-and-java-and
+[markdownj]: http://code.google.com/p/markdownj/
+[showdown]: http://attacklab.net/showdown/
+[rhino]: http://www.mozilla.org/rhino/
+[java6]: http://java.sun.com/javase/6/docs/api/javax/script/package-summary.html
+[j6scripts]: http://www.javalobby.org/java/forums/t87870.html
+[applejvm]: http://jmesnil.net/weblog/2008/05/14/how-to-include-javascript-engine-in-apples-java-6-vm/
Please sign in to comment.
Something went wrong with that request. Please try again.