extractSummary Function

Defined in: lib/RendererUtils.js

Extract the first paragraph of text from a Markdown block of text.

Signature

extractSummary(markdown: String, options: Object) -> String

Parameters (3)

markdown
String
options
Object
options.plainText
Boolean

Pass true if you want the summary in plain-text as opposed to HTML.

Return Value

String

The first paragraph, or the summary.

Made with ♥ using megadoc.