From 83e7dcebc701323f359a1f5268c572af2347f6d4 Mon Sep 17 00:00:00 2001 From: yuin Date: Thu, 2 Jan 2020 01:50:19 +0900 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0bde9c5..7e4ecc8 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Usage ---------------------- Import packages: -``` +```go import ( "bytes" "github.com/yuin/goldmark" @@ -72,6 +72,9 @@ import ( Convert Markdown documents with the CommonMark compliant mode: +```go +``` + ```go var buf bytes.Buffer 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 ------------------------------