zhanshi/goldmark
1
0
Fork 0
mirror of https://github.com/yuin/goldmark synced 2025-03-04 23:04:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
yuin 2020-01-02 01:50:19 +09:00
parent 4b54582dee
commit 83e7dcebc7
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -62,7 +62,7 @@ Usage
---------------------- ----------------------
Import packages: Import packages:
``` ```go
import ( import (
"bytes" "bytes"
"github.com/yuin/goldmark" "github.com/yuin/goldmark"
@ -72,6 +72,9 @@ import (
Convert Markdown documents with the CommonMark compliant mode: Convert Markdown documents with the CommonMark compliant mode:
```go
```
```go ```go
var buf bytes.Buffer var buf bytes.Buffer
if err := goldmark.Convert(source, &buf); err != nil { if err := goldmark.Convert(source, &buf); err != nil {
@ -128,6 +131,14 @@ if err := md.Convert(source, &buf); err != nil {
} }
``` ```
| Functional option | Type |
| ----------------- | ---- |
| `goldmark.WithParser` | `parser.Parser` |
| `goldmark.WithRenderer` | `renderer.Renderer` |
| `goldmark.WithParserOptions` | `...parser.Option` |
| `goldmark.WithRendererOptions` | `...renderer.Option` |
| `goldmark.WithExtensions` | `...goldmark.Extender` |
Parser and Renderer options Parser and Renderer options
------------------------------ ------------------------------