From 6c6efa13b561c6b7541bce781b5472a8e1c59492 Mon Sep 17 00:00:00 2001 From: Russ Ross Date: Sat, 28 May 2011 21:43:17 -0600 Subject: [PATCH] features list --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index e3c8d1c..79c690b 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,33 @@ tool: will build the binary `markdown` in the `example` directory. +Features +-------- + +All features of upskirt are supported, including: + +* The Markdown v1.0.3 test suite passes with the `--tidy` option. + Without `--tidy`, the differences appear to be bugs/dubious + features in the original. + +* Common extensions, including table support, fenced code blocks, + autolinks, strikethroughs, non-strict emphasis, etc. + +* Paranoid parsing, making it safe to feed untrusted used input + without fear of bad things happening. There are still some + corner cases that are untested, but it is already more strict + than upskirt (Go's bounds-checking uncovered a few off-by-one + errors that were present in the C code). + +* Good performance. I have not done rigorous benchmarking, but + informal testing suggests it is pretty fast. Probably not as + fast as upskirt, but probably faster than most others. + +* Minimal dependencies. blackfriday only depends on standard + library packages in Go. The source code is pretty + self-contained, so it is easy to add to any project. + + Extensions ----------