diff options
| author | Michael Muré <batolettre@gmail.com> | 2020-02-05 22:03:19 +0100 |
|---|---|---|
| committer | Michael Muré <batolettre@gmail.com> | 2020-02-05 22:33:03 +0100 |
| commit | 1d4bb7ceb0cef79d68df0bacc913b01e40e6ddd6 (patch) | |
| tree | e088b0fa43058afde1db71541d8fcb4b94905d6e /vendor/github.com/russross/blackfriday/doc.go | |
| parent | f093be96e98284580d61664adecd0a2ff8b354e4 (diff) | |
| download | git-bug-1d4bb7ceb0cef79d68df0bacc913b01e40e6ddd6.tar.gz | |
migrate to go modules
Diffstat (limited to 'vendor/github.com/russross/blackfriday/doc.go')
| -rw-r--r-- | vendor/github.com/russross/blackfriday/doc.go | 32 |
1 files changed, 0 insertions, 32 deletions
diff --git a/vendor/github.com/russross/blackfriday/doc.go b/vendor/github.com/russross/blackfriday/doc.go deleted file mode 100644 index 9656c42a..00000000 --- a/vendor/github.com/russross/blackfriday/doc.go +++ /dev/null @@ -1,32 +0,0 @@ -// Package blackfriday is a Markdown processor. -// -// It translates plain text with simple formatting rules into HTML or LaTeX. -// -// Sanitized Anchor Names -// -// Blackfriday includes an algorithm for creating sanitized anchor names -// corresponding to a given input text. This algorithm is used to create -// anchors for headings when EXTENSION_AUTO_HEADER_IDS is enabled. The -// algorithm is specified below, so that other packages can create -// compatible anchor names and links to those anchors. -// -// The algorithm iterates over the input text, interpreted as UTF-8, -// one Unicode code point (rune) at a time. All runes that are letters (category L) -// or numbers (category N) are considered valid characters. They are mapped to -// lower case, and included in the output. All other runes are considered -// invalid characters. Invalid characters that preceed the first valid character, -// as well as invalid character that follow the last valid character -// are dropped completely. All other sequences of invalid characters -// between two valid characters are replaced with a single dash character '-'. -// -// SanitizedAnchorName exposes this functionality, and can be used to -// create compatible links to the anchor names generated by blackfriday. -// This algorithm is also implemented in a small standalone package at -// github.com/shurcooL/sanitized_anchor_name. It can be useful for clients -// that want a small package and don't need full functionality of blackfriday. -package blackfriday - -// NOTE: Keep Sanitized Anchor Name algorithm in sync with package -// github.com/shurcooL/sanitized_anchor_name. -// Otherwise, users of sanitized_anchor_name will get anchor names -// that are incompatible with those generated by blackfriday. |