summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/yuin/goldmark-highlighting/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/yuin/goldmark-highlighting/README.md')
-rw-r--r--vendor/github.com/yuin/goldmark-highlighting/README.md66
1 files changed, 66 insertions, 0 deletions
diff --git a/vendor/github.com/yuin/goldmark-highlighting/README.md b/vendor/github.com/yuin/goldmark-highlighting/README.md
new file mode 100644
index 0000000000..857b61b036
--- /dev/null
+++ b/vendor/github.com/yuin/goldmark-highlighting/README.md
@@ -0,0 +1,66 @@
+goldmark-highlighting
+=========================
+
+goldmark-highlighting is an extension for the [goldmark](http://github.com/yuin/goldmark)
+that adds syntax-highlighting to the fenced code blocks.
+
+goldmark-highlighting uses [chroma](https://github.com/alecthomas/chroma) as a
+syntax highlighter.
+
+Installation
+--------------------
+
+```
+go get github.com/yuin/goldmark-highlighting
+```
+
+Usage
+--------------------
+
+```go
+import (
+ "bytes"
+ "fmt"
+ "github.com/alecthomas/chroma/formatters/html"
+ "github.com/yuin/goldmark"
+ "github.com/yuin/goldmark/extension"
+ "github.com/yuin/goldmark/parser"
+ "github.com/yuin/goldmark-highlighting"
+
+)
+
+func main() {
+ markdown := goldmark.New(
+ goldmark.WithExtensions(
+ highlighting.Highlighting,
+ ),
+ )
+ var buf bytes.Buffer
+ if err := markdown.Convert([]byte(source), &buf); err != nil {
+ panic(err)
+ }
+ fmt.Print(title)
+}
+```
+
+
+```go
+ markdown := goldmark.New(
+ goldmark.WithExtensions(
+ highlighting.NewHighlighting(
+ highlighting.WithStyle("monokai"),
+ highlighting.WithFormatOptions(
+ html.WithLineNumbers(),
+ ),
+ ),
+ ),
+ )
+```
+
+License
+--------------------
+MIT
+
+Author
+--------------------
+Yusuke Inuzuka