doc: add metadata code example

showdownjs · Oct 16, 2018 · e7294dd · e7294dd
1 parent 7bc285e
commit e7294dd
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -367,6 +367,12 @@ var defaultOptions = showdown.getDefaultOptions();
 
  * **metadata**: (boolean) [default false] Enable support for document metadata (defined at the top of the document
    between `«««` and `»»»` or between `---` and `---`).  (since v.1.8.5)
+   
+   ```js
+   var conv = new showdown.Converter({metadata: true});
+   var html = conv.makeHtml(someMd);
+   var metadata = conv.getMetadata(); // returns an object with the document metadata
+   ```
 
  * **splitAdjacentBlockquotes**: (boolean) [default false] Split adjacent blockquote blocks.(since v.1.8.6)