Rewrote README.md
diff --git a/pkgs/markdown/README.md b/pkgs/markdown/README.md index 5359546..2c660bc 100644 --- a/pkgs/markdown/README.md +++ b/pkgs/markdown/README.md
@@ -1,49 +1,36 @@ -dartdoc markdown library -======================== +markdown +======== -This is a standalone version of the [dartdoc][dartdoc] markdown library. It -parses markdown and converts it to HTML. - -You can see a demo running in the browser [here][demo] (tested in Chrome -and Dartium). The client library currently only supports HTML syntax -highlighting do to some dart:io dependencies in libcss and analyzer_experimental. - -Installation ------------- - -Add this to your `pubspec.yaml` (or create it): -```yaml -dependencies: - markdown: any -``` -Then run the [Pub Package Manager][pub] (comes with the Dart SDK): - - pub install +This is a portable markdown library written in dart. It can parse markdown into +html on both the client and server. Usage ----- +[You can find the installation directions here.][installing] + ```dart import 'package:markdown/markdown.dart' show markdownToHtml; main() { print(markdownToHtml('Hello *Markdown*')); + //=> <p>Hello <em>Markdown</em></p> } ``` -Version 0.4 adds support for GitHub style triple backtick code blocks, with -built in Dart syntax coloring. Custom classifiers can be added using a syntax list: +You can create and use your own syntaxes! ```dart import 'package:markdown/markdown.dart'; main() { - List<InlineSyntax> nyanSyntax = - [new TextSyntax('nyan', sub: '~=[,,_,,]:3')]; - print(markdownToHtml('nyan', inlineSyntaxes: nyanSyntax)); + List<InlineSyntax> syntaxes = [new TextSyntax('nyan', sub: '~=[,,_,,]:3')]; + print(markdownToHtml('nyan', inlineSyntaxes: syntaxes)); + //=> <p>~=[,,_,,]:3</p> } ``` +[You can find the documentation for this library here.][documentation] -[dartdoc]: http://code.google.com/p/dart/source/browse/trunk/dart/sdk/lib/_internal/dartdoc -[pub]: http://www.dartlang.org/docs/pub-package-manager -[demo]: http://dpeek.github.com/dart-markdown +[installing]: http://pub.dartlang.org/packages/markdown#installing +[documentation]: http://www.dartdocs.org/documentation/markdown/0.7.0/index.html +