forked from lug/matterbridge
Update dependencies (#1610)
* Update dependencies * Update module to go 1.17
This commit is contained in:
23
vendor/github.com/gomarkdown/markdown/README.md
generated
vendored
23
vendor/github.com/gomarkdown/markdown/README.md
generated
vendored
@@ -25,6 +25,7 @@ Some tools using this package:
|
||||
- https://github.com/romanyx/mdopen : view markdown files in the default browser
|
||||
- https://github.com/ystyle/sqlmanager : a library for manager sql with markdown like beetsql
|
||||
- https://gitlab.com/kendellfab/fazer : library for making templates
|
||||
- https://github.com/blmayer/tasker : a simple task list web app
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -130,6 +131,12 @@ maybeUnsafeHTML := markdown.ToHTML(md, nil, nil)
|
||||
html := bluemonday.UGCPolicy().SanitizeBytes(maybeUnsafeHTML)
|
||||
```
|
||||
|
||||
## Windows / Mac newlines
|
||||
|
||||
The library only supports Unix newlines. If you have markdown text with possibly
|
||||
Windows / Mac newlines, normalize newlines before caling this librar using
|
||||
`d = markdown.NormalizeNewlines(d)`
|
||||
|
||||
## mdtohtml command-line tool
|
||||
|
||||
https://github.com/gomarkdown/mdtohtml is a command-line markdown to html
|
||||
@@ -259,10 +266,10 @@ implements the following extensions:
|
||||
should be crossed out.
|
||||
|
||||
- **Hard line breaks**. With this extension enabled newlines in the input
|
||||
translate into line breaks in the output. This extension is off by default.
|
||||
translates into line breaks in the output. This extension is off by default.
|
||||
|
||||
- **Non blocking space**. With this extension enabled spaces preceeded by an backslash n the input
|
||||
translate non-blocking spaces in the output. This extension is off by default.
|
||||
- **Non blocking space**. With this extension enabled spaces preceeded by a backslash
|
||||
in the input translates non-blocking spaces in the output. This extension is off by default.
|
||||
|
||||
- **Smart quotes**. Smartypants-style punctuation substitution is
|
||||
supported, turning normal double- and single-quote marks into
|
||||
@@ -281,9 +288,9 @@ implements the following extensions:
|
||||
<sup>4</sup>⁄<sub>5</sub>.
|
||||
|
||||
- **MathJaX Support** is an additional feature which is supported by
|
||||
many markdown editor. It translate inline math equation quoted by `$`
|
||||
and display math block quoted by `$$` into MathJax compatible format.
|
||||
hyphen `_` won't break LaTeX render within a math element any more.
|
||||
many markdown editor. It translates inline math equations quoted by `$`
|
||||
and displays math blocks quoted by `$$` into MathJax compatible format.
|
||||
Hyphens (`_`) won't break LaTeX render within a math element any more.
|
||||
|
||||
```
|
||||
$$
|
||||
@@ -299,13 +306,13 @@ implements the following extensions:
|
||||
$$
|
||||
```
|
||||
|
||||
- **Ordered list start number**. With this extension enabled an ordered list will start with the
|
||||
- **Ordered list start number**. With this extension enabled an ordered list will start with
|
||||
the number that was used to start it.
|
||||
|
||||
- **Super and subscript**. With this extension enabled sequences between ^ will indicate
|
||||
superscript and ~ will become a subscript. For example: H~2~O is a liquid, 2^10^ is 1024.
|
||||
|
||||
- **Block level attributes**, allow setting attributes (ID, classes and key/value pairs) on block
|
||||
- **Block level attributes** allow setting attributes (ID, classes and key/value pairs) on block
|
||||
level elements. The attribute must be enclosed with braces and be put on a line before the
|
||||
element.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user