StarMirror/blackfriday
1
0
Fork 0
mirror of https://github.com/russross/blackfriday.git synced 2024-03-22 13:40:34 +08:00
Code Issues Projects Releases Wiki Activity

Add v1 import path, fix Bluemonday code snippet

Browse Source
This commit is contained in:
Vytautas Šaltenis 2017-05-06 20:35:48 +03:00
parent 52dd06192f
commit a03b7ee643
1 changed files with 7 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -21,15 +21,10 @@ Installation
Blackfriday is compatible with any modern Go release. With Go 1.7 and git
installed:
go get gopkg.in/russross/blackfriday.v2
go get -u gopkg.in/russross/blackfriday.v2
will download, compile, and install the package into your `$GOPATH`
directory hierarchy. Alternatively, you can achieve the same if you
import it into a project:
import "gopkg.in/russross/blackfriday.v2"
and `go get` without parameters.
directory hierarchy.
Versions
@ -55,8 +50,9 @@ Potential drawbacks:
* 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.
Documentation for the legacy v1 can be found here:
https://godoc.org/github.com/russross/blackfriday
If you are still interested in the legacy `v1`, you can import it from
`github.com/russross/blackfriday`. Documentation for the legacy v1 can be found
here: https://godoc.org/github.com/russross/blackfriday
Usage
@ -83,11 +79,11 @@ Here's an example of simple usage of Blackfriday together with Bluemonday:
``` go
import (
"github.com/microcosm-cc/bluemonday"
"github.com/russross/blackfriday"
"gopkg.in/russross/blackfriday.v2"
)
// ...
unsafe := blackfriday.MarkdownCommon(input)
unsafe := blackfriday.Markdown(input)
html := bluemonday.UGCPolicy().SanitizeBytes(unsafe)
```