doc.go (view raw)
1// Package blackfriday is a markdown processor.
2//
3// It translates plain text with simple formatting rules into an AST, which can
4// then be further processed to HTML (provided by Blackfriday itself) or other
5// formats (provided by the community).
6//
7// The simplest way to invoke Blackfriday is to call the Run function. It will
8// take a text input and produce a text output in HTML (or other format).
9//
10// A slightly more sophisticated way to use Blackfriday is to create a Markdown
11// processor and to call Parse, which returns a syntax tree for the input
12// document. You can leverage Blackfriday's parsing for content extraction from
13// markdown documents. You can assign a custom renderer and set various options
14// to the Markdown processor.
15//
16// If you're interested in calling Blackfriday from command line, see
17// https://github.com/russross/blackfriday-tool.
18package blackfriday