all repos — grayfriday @ e0df70211230f75ef418655c3bfb721c37010345

blackfriday fork with a few changes

Merge pull request #382 from russross/v2-final-docs-fixes

Several small documentation fixes
Vytautas Ĺ altenis vytas@rtfb.lt
Tue, 01 Aug 2017 23:01:04 +0300
commit

e0df70211230f75ef418655c3bfb721c37010345

parent

f42ca5bf18fa5a63ca3a33fe9c5d0415f257eb0a

3 files changed, 18 insertions(+), 12 deletions(-)

jump to
M README.mdREADME.md

@@ -52,8 +52,9 @@ * Our benchmarks show v2 to be slightly slower than v1. Currently in the

ballpark of around 15%. * API breakage. If you can't afford modifying your code to adhere to the new API and don't care too much about the new features, v2 is probably not for you. -* Some bug fixes are trailing behind and still need to be forward-ported to v2. - See issue #348 for tracking. +* Several bug fixes are trailing behind and still need to be forward-ported to + v2. See issue [#348](https://github.com/russross/blackfriday/issues/348) for + tracking. Usage -----

@@ -61,13 +62,17 @@

For the most sensible markdown processing, it is as simple as getting your input into a byte slice and calling: - output := blackfriday.Run(input) +```go +output := blackfriday.Run(input) +``` Your input will be parsed and the output rendered with a set of most popular extensions enabled. If you want the most basic feature set, corresponding with the bare Markdown specification, use: - output := blackfriday.Run(input, blackfriday.WithNoExtensions()) +```go +output := blackfriday.Run(input, blackfriday.WithNoExtensions()) +``` ### Sanitize untrusted content

@@ -77,7 +82,7 @@ through HTML sanitizer such as [Bluemonday][5].

Here's an example of simple usage of Blackfriday together with Bluemonday: -``` go +```go import ( "github.com/microcosm-cc/bluemonday" "github.com/russross/blackfriday"

@@ -179,7 +184,7 @@ indentation to mark code blocks, you can explicitly mark them

and supply a language (to make syntax highlighting simple). Just mark it like this: - ``` go + ```go func getTrue() bool { return true }
M doc.godoc.go

@@ -4,8 +4,8 @@ // It translates plain text with simple formatting rules into an AST, which can

// then be further processed to HTML (provided by Blackfriday itself) or other // formats (provided by the community). // -// The simplest way to invoke Blackfriday is to call the Markdown function. It -// will take a text input and produce a text output in HTML (or other format). +// The simplest way to invoke Blackfriday is to call the Run function. It will +// take a text input and produce a text output in HTML (or other format). // // A slightly more sophisticated way to use Blackfriday is to create a Markdown // processor and to call Parse, which returns a syntax tree for the input
M markdown.gomarkdown.go

@@ -19,7 +19,8 @@ //

// Markdown parsing and processing // -// Version string of the package. +// Version string of the package. Appears in the rendered document when +// CompletePage flag is on. const Version = "2.0" // Extensions is a bitwise or'ed collection of enabled Blackfriday's

@@ -167,9 +168,8 @@ // Callback functions for inline parsing. One such function is defined

// for each character that triggers a response when parsing inline data. type inlineParser func(p *Markdown, data []byte, offset int) (int, *Node) -// Markdown is a type that holds: -// - extensions and the runtime state used by Parse, -// - the renderer. +// Markdown is a type that holds extensions and the runtime state used by +// Parse, and the renderer. You can not use it directly, construct it with New. type Markdown struct { renderer Renderer referenceOverride ReferenceOverrideFunc

@@ -399,6 +399,7 @@ // Parse is an entry point to the parsing part of Blackfriday. It takes an

// input markdown document and produces a syntax tree for its contents. This // tree can then be rendered with a default or custom renderer, or // analyzed/transformed by the caller to whatever non-standard needs they have. +// The return value is the root node of the syntax tree. func (p *Markdown) Parse(input []byte) *Node { p.block(input) // Walk the tree and finish up some of unfinished blocks