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 one of Markdown*
8// functions. It will take a text input and produce a text output in HTML (or
9// other format).
10//
11// A slightly more sophisticated way to use Blackfriday is to call Parse, which
12// returns a syntax tree for the input document. You can use that to write your
13// own renderer or, for example, to leverage Blackfriday's parsing for content
14// extraction from markdown documents.
15//
16// If you're interested in calling Blackfriday from command line, see
17// https://github.com/russross/blackfriday-tool.
18package blackfriday