This is some sample code.
-func main() { -fmt.Println("Hi") -} --``` - -## Real-life example - -In [smallblog](https://github.com/Depado/smallblog) I'm using bfchroma to render -my articles. It's using a combination of both bfchroma's options and blackfriday -extensions and flags. - -```go -package main - -import ( - "github.com/Depado/bfchroma" - "github.com/alecthomas/chroma/formatters/html" - bf "github.com/russross/blackfriday" -) - -// Defines the extensions that are used -var exts = bf.NoIntraEmphasis | bf.Tables | bf.FencedCode | bf.Autolink | - bf.Strikethrough | bf.SpaceHeadings | bf.BackslashLineBreak | - bf.DefinitionLists | bf.Footnotes - -// Defines the HTML rendering flags that are used -var flags = bf.UseXHTML | bf.Smartypants | bf.SmartypantsFractions | - bf.SmartypantsDashes | bf.SmartypantsLatexDashes | bf.TOC - -// render will take a []byte input and will render it using a new renderer each -// time because reusing the same can mess with TOC and header IDs -func render(input []byte) []byte { - return bf.Run( - input, - bf.WithRenderer( - bfchroma.NewRenderer( - bfchroma.WithoutAutodetect(), - bfchroma.ChromaOptions( - html.WithLineNumbers(), - ), - bfchroma.Extend( - bf.NewHTMLRenderer(bf.HTMLRendererParameters{ - Flags: flags, - }), - ), - ), - ), - bf.WithExtensions(exts), - ) -} -``` - - -## ToDo - -- [ ] Allow the use of `html.WithClasses()` diff --git a/vendor/github.com/Depado/bfchroma/renderer.go b/vendor/github.com/Depado/bfchroma/renderer.go deleted file mode 100644 index 4101b980..00000000 --- a/vendor/github.com/Depado/bfchroma/renderer.go +++ /dev/null @@ -1,127 +0,0 @@ -// Package bfchroma provides an easy and extensible blackfriday renderer that -// uses the chroma syntax highlighter to render code blocks. -package bfchroma - -import ( - "io" - - "github.com/alecthomas/chroma" - "github.com/alecthomas/chroma/formatters/html" - "github.com/alecthomas/chroma/lexers" - "github.com/alecthomas/chroma/styles" - bf "gopkg.in/russross/blackfriday.v2" -) - -// Option defines the functional option type -type Option func(r *Renderer) - -// Style is a function option allowing to set the style used by chroma -// Default : "monokai" -func Style(s string) Option { - return func(r *Renderer) { - r.Style = styles.Get(s) - } -} - -// ChromaStyle is an option to directly set the style of the renderer using a -// chroma style instead of a string -func ChromaStyle(s *chroma.Style) Option { - return func(r *Renderer) { - r.Style = s - } -} - -// WithoutAutodetect disables chroma's language detection when no codeblock -// extra information is given. It will fallback to a sane default instead of -// trying to detect the language. -func WithoutAutodetect() Option { - return func(r *Renderer) { - r.Autodetect = false - } -} - -// ChromaOptions allows to pass Chroma html.Option such as Standalone() -// WithClasses(), ClassPrefix(prefix)... -func ChromaOptions(options ...html.Option) Option { - return func(r *Renderer) { - r.ChromaOptions = options - } -} - -// Extend allows to specify the blackfriday renderer which is extended -func Extend(br bf.Renderer) Option { - return func(r *Renderer) { - r.Base = br - } -} - -// NewRenderer will return a new bfchroma renderer with sane defaults -func NewRenderer(options ...Option) *Renderer { - r := &Renderer{ - Base: bf.NewHTMLRenderer(bf.HTMLRendererParameters{ - Flags: bf.CommonHTMLFlags, - }), - Style: styles.Monokai, - Autodetect: true, - } - for _, option := range options { - option(r) - } - r.Formatter = html.New(r.ChromaOptions...) - return r -} - -// RenderWithChroma will render the given text to the w io.Writer -func (r *Renderer) RenderWithChroma(w io.Writer, text []byte, data bf.CodeBlockData) error { - var lexer chroma.Lexer - - // Determining the lexer to use - if len(data.Info) > 0 { - lexer = lexers.Get(string(data.Info)) - } else if r.Autodetect { - lexer = lexers.Analyse(string(text)) - } - if lexer == nil { - lexer = lexers.Fallback - } - - // Tokenize the code - iterator, err := lexer.Tokenise(nil, string(text)) - if err != nil { - return err - } - return r.Formatter.Format(w, r.Style, iterator) -} - -// Renderer is a custom Blackfriday renderer that uses the capabilities of -// chroma to highlight code with triple backtick notation -type Renderer struct { - Base bf.Renderer - Autodetect bool - ChromaOptions []html.Option - Style *chroma.Style - Formatter *html.Formatter -} - -// RenderNode satisfies the Renderer interface -func (r *Renderer) RenderNode(w io.Writer, node *bf.Node, entering bool) bf.WalkStatus { - switch node.Type { - case bf.CodeBlock: - if err := r.RenderWithChroma(w, node.Literal, node.CodeBlockData); err != nil { - return r.Base.RenderNode(w, node, entering) - } - return bf.SkipChildren - default: - return r.Base.RenderNode(w, node, entering) - } -} - -// RenderHeader satisfies the Renderer interface -func (r *Renderer) RenderHeader(w io.Writer, ast *bf.Node) { - r.Base.RenderHeader(w, ast) -} - -// RenderFooter satisfies the Renderer interface -func (r *Renderer) RenderFooter(w io.Writer, ast *bf.Node) { - r.Base.RenderFooter(w, ast) -} diff --git a/vendor/github.com/alecthomas/chroma/.gitignore b/vendor/github.com/alecthomas/chroma/.gitignore deleted file mode 100644 index 94dc6b97..00000000 --- a/vendor/github.com/alecthomas/chroma/.gitignore +++ /dev/null @@ -1,18 +0,0 @@ -# Binaries for programs and plugins -*.exe -*.dll -*.so -*.dylib -/cmd/chroma/chroma - -# Test binary, build with `go test -c` -*.test - -# Output of the go coverage tool, specifically when used with LiteIDE -*.out - -# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736 -.glide/ - -_models/ - diff --git a/vendor/github.com/alecthomas/chroma/.goreleaser.yml b/vendor/github.com/alecthomas/chroma/.goreleaser.yml deleted file mode 100644 index e90c5113..00000000 --- a/vendor/github.com/alecthomas/chroma/.goreleaser.yml +++ /dev/null @@ -1,31 +0,0 @@ -project_name: chroma -release: - github: - owner: alecthomas - name: chroma -brew: - install: bin.install "chroma" -builds: -- goos: - - linux - - darwin - - windows - goarch: - - amd64 - - "386" - goarm: - - "6" - main: ./cmd/chroma/main.go - ldflags: -s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}} - binary: chroma -archive: - format: tar.gz - name_template: '{{ .Binary }}-{{ .Version }}-{{ .Os }}-{{ .Arch }}{{ if .Arm }}v{{ - .Arm }}{{ end }}' - files: - - COPYING - - README* -snapshot: - name_template: SNAPSHOT-{{ .Commit }} -checksum: - name_template: '{{ .ProjectName }}-{{ .Version }}-checksums.txt' diff --git a/vendor/github.com/alecthomas/chroma/.travis.yml b/vendor/github.com/alecthomas/chroma/.travis.yml deleted file mode 100644 index 3e27eb3e..00000000 --- a/vendor/github.com/alecthomas/chroma/.travis.yml +++ /dev/null @@ -1,5 +0,0 @@ -sudo: false -language: go -after_success: - go get github.com/goreleaser/goreleaser && goreleaser - diff --git a/vendor/github.com/alecthomas/chroma/COPYING b/vendor/github.com/alecthomas/chroma/COPYING deleted file mode 100644 index 92dc39f7..00000000 --- a/vendor/github.com/alecthomas/chroma/COPYING +++ /dev/null @@ -1,19 +0,0 @@ -Copyright (C) 2017 Alec Thomas - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies -of the Software, and to permit persons to whom the Software is furnished to do -so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/vendor/github.com/alecthomas/chroma/README.md b/vendor/github.com/alecthomas/chroma/README.md deleted file mode 100644 index 5b62bac7..00000000 --- a/vendor/github.com/alecthomas/chroma/README.md +++ /dev/null @@ -1,207 +0,0 @@ -# Chroma - A general purpose syntax highlighter in pure Go [](http://godoc.org/github.com/alecthomas/chroma) [](https://travis-ci.org/alecthomas/chroma) [](https://gitter.im/alecthomas/Lobby) - -> **NOTE:** As Chroma has just been released, its API is still in flux. That said, the high-level interface should not change significantly. - -Chroma takes source code and other structured text and converts it into syntax -highlighted HTML, ANSI-coloured text, etc. - -Chroma is based heavily on [Pygments](http://pygments.org/), and includes -translators for Pygments lexers and styles. - -## Table of Contents - - - -- [Supported languages](#supported-languages) -- [Using the library](#using-the-library) - - [Quick start](#quick-start) - - [Identifying the language](#identifying-the-language) - - [Formatting the output](#formatting-the-output) - - [The HTML formatter](#the-html-formatter) -- [More detail](#more-detail) - - [Lexers](#lexers) - - [Formatters](#formatters) - - [Styles](#styles) -- [Command-line interface](#command-line-interface) -- [What's missing compared to Pygments?](#whats-missing-compared-to-pygments) - - - -## Supported languages - -ABNF, ANTLR, APL, ActionScript, ActionScript 3, Ada, Angular2, ApacheConf, AppleScript, Awk, BNF, Base Makefile, Bash, Batchfile, BlitzBasic, Brainfuck, C, C#, C++, CFEngine3, CMake, COBOL, CSS, Cap'n Proto, Ceylon, ChaiScript, Cheetah, Clojure, CoffeeScript, Common Lisp, Coq, Crystal, Cython, DTD, Dart, Diff, Django/Jinja, Docker, EBNF, Elixir, Elm, EmacsLisp, Erlang, FSharp, Factor, Fish, Forth, Fortran, GAS, GDScript, GLSL, Genshi, Genshi HTML, Genshi Text, Gnuplot, Go, Groovy, HTML, Handlebars, Haskell, Haxe, Hexdump, Hy, INI, Idris, Io, JSON, Java, JavaScript, Julia, Kotlin, LLVM, Lighttpd configuration file, Lua, Mako, Mason, Mathematica, MiniZinc, Modula-2, MySQL, Myghty, NASM, Newspeak, Nginx configuration file, Nim, OCaml, Octave, PHP, PL/pgSQL, POVRay, PacmanConf, Perl, Pig, PkgConfig, PostScript, PostgreSQL SQL dialect, PowerShell, Prolog, Protocol Buffer, Puppet, Python, Python 3, QBasic, R, Racket, Ragel, Rexx, Ruby, Rust, SPARQL, SQL, Sass, Scala, Scheme, Scilab, Smalltalk, Smarty, Snobol, SquidConf, SVG, Swift, TASM, Tcl, Tcsh, Termcap, Terminfo, Terraform, Thrift, Transact-SQL, Turtle, Twig, TypeScript, TypoScript, TypoScriptCssData, TypoScriptHtmlData, VHDL, VimL, XML, Xorg, YAML, cfstatement, markdown, reStructuredText, reg, systemverilog, verilog - -_I will attempt to keep this section up to date, but an authoritative list can be -displayed with `chroma --list`._ - -## Using the library - -Chroma, like Pygments, has the concepts of -[lexers](https://github.com/alecthomas/chroma/tree/master/lexers), -[formatters](https://github.com/alecthomas/chroma/tree/master/formatters) and -[styles](https://github.com/alecthomas/chroma/tree/master/styles). - -Lexers convert source text into a stream of tokens, styles specify how token -types are mapped to colours, and formatters convert tokens and styles into -formatted output. - -A package exists for each of these, containing a global `Registry` variable -with all of the registered implementations. There are also helper functions -for using the registry in each package, such as looking up lexers by name or -matching filenames, etc. - -In all cases, if a lexer, formatter or style can not be determined, `nil` will -be returned. In this situation you may want to default to the `Fallback` -value in each respective package, which provides sane defaults. - -### Quick start - -A convenience function exists that can be used to simply format some source -text, without any effort: - -```go -err := quick.Highlight(os.Stdout, someSourceCode, "go", "html", "monokai") -``` - -### Identifying the language - -To highlight code, you'll first have to identify what language the code is -written in. There are three primary ways to do that: - -1. Detect the language from its filename. - - ```go - lexer := lexers.Match("foo.go") - ``` - -3. Explicitly specify the language by its Chroma syntax ID (a full list is available from `lexers.Names()`). - - ```go - lexer := lexers.Get("go") - ``` - -3. Detect the language from its content. - - ```go - lexer := lexers.Analyse("package main\n\nfunc main()\n{\n}\n") - ``` - -In all cases, `nil` will be returned if the language can not be identified. - -```go -if lexer == nil { - lexer = lexers.Fallback -} -``` - -At this point, it should be noted that some lexers can be extremely chatty. To -mitigate this, you can use the coalescing lexer to coalesce runs of identical -token types into a single token: - -```go -lexer = chroma.Coalesce(lexer) -``` - -### Formatting the output - -Once a language is identified you will need to pick a formatter and a style (theme). - -```go -style := styles.Get("swapoff") -if style == nil { - style = styles.Fallback -} -formatter := formatters.Get("html") -if formatter == nil { - formatter = formatters.Fallback -} -``` - -Then obtain an iterator over the tokens: - -```go -contents, err := ioutil.ReadAll(r) -iterator, err := lexer.Tokenise(nil, string(contents)) -``` - -And finally, format the tokens from the iterator: - -```go -err := formatter.Format(w, style, iterator) -``` - -### The HTML formatter - -By default the `html` registered formatter generates standalone HTML with -embedded CSS. More flexibility is available through the `lexers/html` package. - -Firstly, the output generated by the formatter can be customised with the -following constructor options: - -- `Standalone()` - generate standalone HTML with embedded CSS. -- `WithClasses()` - use classes rather than inlined style attributes. -- `ClassPrefix(prefix)` - prefix each generated CSS class. -- `TabWidth(width)` - Set the rendered tab width, in characters. -- `WithLineNumbers()` - Render line numbers (style with `LineNumbers`). -- `HighlightLines(ranges)` - Highlight lines in these ranges (style with `LineHighlight`). - -If `WithClasses()` is used, the corresponding CSS can be obtained from the formatter with: - -```go -formatter := html.New(html.WithClasses()) -err := formatter.WriteCSS(w, style) -``` - -## More detail - -### Lexers - -See the [Pygments documentation](http://pygments.org/docs/lexerdevelopment/) -for details on implementing lexers. Most concepts apply directly to Chroma, -but see existing lexer implementations for real examples. - -In many cases lexers can be automatically converted directly from Pygments by -using the included Python 3 script `pygments2chroma.py`. I use something like -the following: - -``` -python3 ~/Projects/chroma/_tools/pygments2chroma.py \ - pygments.lexers.jvm.KotlinLexer \ - > ~/Projects/chroma/lexers/kotlin.go \ - && gofmt -s -w ~/Projects/chroma/lexers/*.go -``` - -See notes in [pygments-lexers.go](https://github.com/alecthomas/chroma/blob/master/pygments-lexers.txt) -for a list of lexers, and notes on some of the issues importing them. - -### Formatters - -Chroma supports HTML output, as well as terminal output in 8 colour, 256 colour, and true-colour. - -A `noop` formatter is included that outputs the token text only, and a `tokens` -formatter outputs raw tokens. The latter is useful for debugging lexers. - -### Styles - -Chroma styles use the [same syntax](http://pygments.org/docs/styles/) as Pygments. - -All Pygments styles have been converted to Chroma using the `_tools/style.py` script. - -## Command-line interface - -A command-line interface to Chroma is included. It can be installed with: - -``` -go get -u github.com/alecthomas/chroma/cmd/chroma -``` - -## What's missing compared to Pygments? - -- Quite a few lexers, for various reasons (pull-requests welcome): - - Pygments lexers for complex languages often include custom code to - handle certain aspects, such as Perl6's ability to nest code inside - regular expressions. These require time and effort to convert. - - I mostly only converted languages I had heard of, to reduce the porting cost. -- Some more esoteric features of Pygments are omitted for simplicity. -- Though the Chroma API supports content detection, very few languages support them. - I have plans to implement a statistical analyser at some point, but not enough time. diff --git a/vendor/github.com/alecthomas/chroma/coalesce.go b/vendor/github.com/alecthomas/chroma/coalesce.go deleted file mode 100644 index 688017a4..00000000 --- a/vendor/github.com/alecthomas/chroma/coalesce.go +++ /dev/null @@ -1,32 +0,0 @@ -package chroma - -// Coalesce is a Lexer interceptor that collapses runs of common types into a single token. -func Coalesce(lexer Lexer) Lexer { return &coalescer{lexer} } - -type coalescer struct{ Lexer } - -func (d *coalescer) Tokenise(options *TokeniseOptions, text string) (Iterator, error) { - var prev *Token - it, err := d.Lexer.Tokenise(options, text) - if err != nil { - return nil, err - } - return func() *Token { - for token := it(); token != nil; token = it() { - if prev == nil { - prev = token - } else { - if prev.Type == token.Type && len(prev.Value) < 8192 { - prev.Value += token.Value - } else { - out := prev - prev = token - return out - } - } - } - out := prev - prev = nil - return out - }, nil -} diff --git a/vendor/github.com/alecthomas/chroma/colour.go b/vendor/github.com/alecthomas/chroma/colour.go deleted file mode 100644 index edaa480d..00000000 --- a/vendor/github.com/alecthomas/chroma/colour.go +++ /dev/null @@ -1,153 +0,0 @@ -package chroma - -import ( - "fmt" - "math" - "strconv" - "strings" -) - -// ANSI2RGB maps ANSI colour names, as supported by Chroma, to hex RGB values. -var ANSI2RGB = map[string]string{ - "#ansiblack": "000000", - "#ansidarkred": "7f0000", - "#ansidarkgreen": "007f00", - "#ansibrown": "7f7fe0", - "#ansidarkblue": "00007f", - "#ansipurple": "7f007f", - "#ansiteal": "007f7f", - "#ansilightgray": "e5e5e5", - // Normal - "#ansidarkgray": "555555", - "#ansired": "ff0000", - "#ansigreen": "00ff00", - "#ansiyellow": "ffff00", - "#ansiblue": "0000ff", - "#ansifuchsia": "ff00ff", - "#ansiturquoise": "00ffff", - "#ansiwhite": "ffffff", - - // Aliases without the "ansi" prefix, because...why? - "#black": "000000", - "#darkred": "7f0000", - "#darkgreen": "007f00", - "#brown": "7f7fe0", - "#darkblue": "00007f", - "#purple": "7f007f", - "#teal": "007f7f", - "#lightgray": "e5e5e5", - // Normal - "#darkgray": "555555", - "#red": "ff0000", - "#green": "00ff00", - "#yellow": "ffff00", - "#blue": "0000ff", - "#fuchsia": "ff00ff", - "#turquoise": "00ffff", - "#white": "ffffff", -} - -// Colour represents an RGB colour. -type Colour int32 - -// NewColour creates a Colour directly from RGB values. -func NewColour(r, g, b uint8) Colour { - return ParseColour(fmt.Sprintf("%02x%02x%02x", r, g, b)) -} - -// Distance between this colour and another. -// -// This uses the approach described here (https://www.compuphase.com/cmetric.htm). -// This is not as accurate as LAB, et. al. but is *vastly* simpler and sufficient for our needs. -func (c Colour) Distance(e2 Colour) float64 { - rmean := int(c.Red()+e2.Red()) / 2 - r := int(c.Red() - e2.Red()) - g := int(c.Green() - e2.Green()) - b := int(c.Blue() - e2.Blue()) - return math.Sqrt(float64((((512 + rmean) * r * r) >> 8) + 4*g*g + (((767 - rmean) * b * b) >> 8))) -} - -// Brighten returns a copy of this colour with its brightness adjusted. -// -// If factor is negative, the colour is darkened. -// -// Uses approach described here (http://www.pvladov.com/2012/09/make-color-lighter-or-darker.html). -func (c Colour) Brighten(factor float64) Colour { - r := float64(c.Red()) - g := float64(c.Green()) - b := float64(c.Blue()) - - if factor < 0 { - factor++ - r *= factor - g *= factor - b *= factor - } else { - r = (255-r)*factor + r - g = (255-g)*factor + g - b = (255-b)*factor + b - } - return NewColour(uint8(r), uint8(g), uint8(b)) -} - -// Brightness of the colour (roughly) in the range 0.0 to 1.0 -func (c Colour) Brightness() float64 { - return (float64(c.Red()) + float64(c.Green()) + float64(c.Blue())) / 255.0 / 3.0 -} - -// ParseColour in the forms #rgb, #rrggbb, #ansi