danog/blackfriday
1
0
Fork 0
mirror of https://github.com/danog/blackfriday.git synced 2024-12-02 09:27:49 +01:00
Code Issues Projects Releases Wiki Activity

Update README with the latest changes from v2

Browse Source
This commit is contained in:
Vytautas Šaltenis 2017-08-11 22:47:52 +03:00
parent a03b7ee643
commit 8ad7e40db0
1 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -49,6 +49,9 @@ Potential drawbacks:
ballpark of around 15%. ballpark of around 15%.
* API breakage. If you can't afford modifying your code to adhere to the new API * 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. and don't care too much about the new features, v2 is probably not for you.
* 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.
If you are still interested in the legacy `v1`, you can import it from 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 `github.com/russross/blackfriday`. Documentation for the legacy v1 can be found
@ -58,6 +61,8 @@ here: https://godoc.org/github.com/russross/blackfriday
Usage Usage
----- -----
### v1
For basic usage, it is as simple as getting your input into a byte For basic usage, it is as simple as getting your input into a byte
slice and calling: slice and calling:
@ -68,6 +73,23 @@ feature set, use this instead:
output := blackfriday.MarkdownCommon(input) output := blackfriday.MarkdownCommon(input)
### v2
For the most sensible markdown processing, it is as simple as getting your input
into a byte slice and calling:
```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:
```go
output := blackfriday.Run(input, blackfriday.WithNoExtensions())
```
### Sanitize untrusted content ### Sanitize untrusted content
Blackfriday itself does nothing to protect against malicious content. If you are Blackfriday itself does nothing to protect against malicious content. If you are
@ -83,11 +105,11 @@ import (
) )
// ... // ...
unsafe := blackfriday.Markdown(input) unsafe := blackfriday.Run(input)
html := bluemonday.UGCPolicy().SanitizeBytes(unsafe) html := bluemonday.UGCPolicy().SanitizeBytes(unsafe)
``` ```
### Custom options ### Custom options, v1
If you want to customize the set of options, first get a renderer If you want to customize the set of options, first get a renderer
(currently only the HTML output engine), then use it to (currently only the HTML output engine), then use it to
@ -95,6 +117,13 @@ call the more general `Markdown` function. For examples, see the
implementations of `MarkdownBasic` and `MarkdownCommon` in implementations of `MarkdownBasic` and `MarkdownCommon` in
`markdown.go`. `markdown.go`.
### Custom options, v2
If you want to customize the set of options, use `blackfriday.WithExtensions`,
`blackfriday.WithRenderer` and `blackfriday.WithRefOverride`.
### `blackfriday-tool`
You can also check out `blackfriday-tool` for a more complete example You can also check out `blackfriday-tool` for a more complete example
of how to use it. Download and install it using: of how to use it. Download and install it using: