summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/russross/blackfriday/doc.go
diff options
context:
space:
mode:
authorDuco van Amstel <duco.vanamstel@gmail.com>2018-10-22 10:48:29 -0700
committerWim <wim@42.be>2018-10-22 19:48:29 +0200
commitf2cdda7278e01b548f8aff6567376ae2f15c1803 (patch)
treece6edbde50dc721b366e97e43c2726df808b59f8 /vendor/github.com/russross/blackfriday/doc.go
parent6911458d15f548070da870cc7f68c2a882f1c674 (diff)
downloadmatterbridge-msglm-f2cdda7278e01b548f8aff6567376ae2f15c1803.tar.gz
matterbridge-msglm-f2cdda7278e01b548f8aff6567376ae2f15c1803.tar.bz2
matterbridge-msglm-f2cdda7278e01b548f8aff6567376ae2f15c1803.zip
Update Blackfriday dependency (closes #522) (#532)
- Fixup Telegram bridge implementation to support updated dependency.
Diffstat (limited to 'vendor/github.com/russross/blackfriday/doc.go')
-rw-r--r--vendor/github.com/russross/blackfriday/doc.go40
1 files changed, 13 insertions, 27 deletions
diff --git a/vendor/github.com/russross/blackfriday/doc.go b/vendor/github.com/russross/blackfriday/doc.go
index 9656c42a..5b3fa987 100644
--- a/vendor/github.com/russross/blackfriday/doc.go
+++ b/vendor/github.com/russross/blackfriday/doc.go
@@ -1,32 +1,18 @@
-// Package blackfriday is a Markdown processor.
+// Package blackfriday is a markdown processor.
//
-// It translates plain text with simple formatting rules into HTML or LaTeX.
+// It translates plain text with simple formatting rules into an AST, which can
+// then be further processed to HTML (provided by Blackfriday itself) or other
+// formats (provided by the community).
//
-// Sanitized Anchor Names
+// The simplest way to invoke Blackfriday is to call the Run function. It will
+// take a text input and produce a text output in HTML (or other format).
//
-// 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.
+// A slightly more sophisticated way to use Blackfriday is to create a Markdown
+// processor and to call Parse, which returns a syntax tree for the input
+// document. You can leverage Blackfriday's parsing for content extraction from
+// markdown documents. You can assign a custom renderer and set various options
+// to the Markdown processor.
//
-// 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.
+// If you're interested in calling Blackfriday from command line, see
+// https://github.com/russross/blackfriday-tool.
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.