Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(30)

Unified Diff: third_party/pkg/markdown/README.md

Issue 18497012: Add markdown to third_party/pkg (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 7 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: third_party/pkg/markdown/README.md
diff --git a/third_party/pkg/markdown/README.md b/third_party/pkg/markdown/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..53595464ab109fcb5b17d2fff790332294391b15
--- /dev/null
+++ b/third_party/pkg/markdown/README.md
@@ -0,0 +1,49 @@
+dartdoc markdown library
+========================
+
+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
+
+Usage
+-----
+
+```dart
+import 'package:markdown/markdown.dart' show markdownToHtml;
+
+main() {
+ print(markdownToHtml('Hello *Markdown*'));
+}
+```
+
+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:
+
+```dart
+import 'package:markdown/markdown.dart';
+
+main() {
+ List<InlineSyntax> nyanSyntax =
+ [new TextSyntax('nyan', sub: '~=[,,_,,]:3')];
+ print(markdownToHtml('nyan', inlineSyntaxes: nyanSyntax));
+}
+```
+
+[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

Powered by Google App Engine
This is Rietveld 408576698