Are you sure you want to delete this task? Once this task is deleted, it cannot be recovered.
colorfulberry 40d0274bc7 | 4 years ago | |
---|---|---|
.. | ||
.gitignore | 4 years ago | |
.travis.yml | 4 years ago | |
LICENSE.txt | 4 years ago | |
README.md | 4 years ago | |
block.go | 4 years ago | |
doc.go | 4 years ago | |
esc.go | 4 years ago | |
go.mod | 4 years ago | |
html.go | 4 years ago | |
inline.go | 4 years ago | |
markdown.go | 4 years ago | |
node.go | 4 years ago | |
smartypants.go | 4 years ago |
Blackfriday is a Markdown processor implemented in Go. It
is paranoid about its input (so you can safely feed it user-supplied
data), it is fast, it supports common extensions (tables, smart
punctuation substitutions, etc.), and it is safe for all utf-8
(unicode) input.
HTML output is currently supported, along with Smartypants
extensions.
It started as a translation from C of Sundown.
Blackfriday is compatible with any modern Go release. With Go 1.7 and git
installed:
go get gopkg.in/russross/blackfriday.v2
will download, compile, and install the package into your $GOPATH
directory hierarchy. Alternatively, you can achieve the same if you
import it into a project:
import "gopkg.in/russross/blackfriday.v2"
and go get
without parameters.
Currently maintained and recommended version of Blackfriday is v2
. It's being
developed on its own branch: https://github.com/russross/blackfriday/tree/v2 and the
documentation is available at
https://godoc.org/gopkg.in/russross/blackfriday.v2.
It is go get
-able via via gopkg.in at gopkg.in/russross/blackfriday.v2
,
but we highly recommend using package management tool like [dep][7] or
[Glide][8] and make use of semantic versioning. With package management you
should import github.com/russross/blackfriday
and specify that you're using
version 2.0.0.
Version 2 offers a number of improvements over v1:
Parse
, which produces an abstract syntax tree forPotential drawbacks:
For the most sensible markdown processing, it is as simple as getting your input
into a byte slice and calling:
output := blackfriday.Run(input)
Your input will be parsed and the output rendered with a set of most popular
extensions enabled. If you want the most basic feature set, corresponding with
the bare Markdown specification, use:
output := blackfriday.Run(input, blackfriday.WithNoExtensions())
Blackfriday itself does nothing to protect against malicious content. If you are
dealing with user-supplied markdown, we recommend running Blackfriday's output
through HTML sanitizer such as Bluemonday.
Here's an example of simple usage of Blackfriday together with Bluemonday:
import (
"github.com/microcosm-cc/bluemonday"
"github.com/russross/blackfriday"
)
// ...
unsafe := blackfriday.Run(input)
html := bluemonday.UGCPolicy().SanitizeBytes(unsafe)
If you want to customize the set of options, use blackfriday.WithExtensions
,
blackfriday.WithRenderer
and blackfriday.WithRefOverride
.
You can also check out blackfriday-tool
for a more complete example
of how to use it. Download and install it using:
go get github.com/russross/blackfriday-tool
This is a simple command-line tool that allows you to process a
markdown file using a standalone program. You can also browse the
source directly on github if you are just looking for some example
code:
Note that if you have not already done so, installing
blackfriday-tool
will be sufficient to download and install
blackfriday in addition to the tool itself. The tool binary will be
installed in $GOPATH/bin
. This is a statically-linked binary that
can be copied to wherever you need it without worrying about
dependencies and library versions.
All features of Sundown are supported, including:
Compatibility. The Markdown v1.0.3 test suite passes with
the --tidy
option. Without --tidy
, the differences are
mostly in whitespace and entity escaping, where blackfriday is
more consistent and cleaner.
Common extensions, including table support, fenced code
blocks, autolinks, strikethroughs, non-strict emphasis, etc.
Safety. Blackfriday is paranoid when parsing, making it safe
to feed untrusted user input without fear of bad things
happening. The test suite stress tests this and there are no
known inputs that make it crash. If you find one, please let me
know and send me the input that does it.
NOTE: "safety" in this context means runtime safety only. In order to
protect yourself against JavaScript injection in untrusted content, see
this example.
Fast processing. It is fast enough to render on-demand in
most web applications without having to cache the output.
Thread safety. You can run multiple parsers in different
goroutines without ill effect. There is no dependence on global
shared state.
Minimal dependencies. Blackfriday only depends on standard
library packages in Go. The source code is pretty
self-contained, so it is easy to add to any project, including
Google App Engine projects.
Standards compliant. Output successfully validates using the
W3C validation tool for HTML 4.01 and XHTML 1.0 Transitional.
In addition to the standard markdown syntax, this package
implements the following extensions:
Intra-word emphasis supression. The _
character is
commonly used inside words when discussing code, so having
markdown interpret it as an emphasis command is usually the
wrong thing. Blackfriday lets you treat all emphasis markers as
normal characters when they occur inside a word.
Tables. Tables can be created by drawing them in the input
using a simple syntax:
Name | Age
--------|------
Bob | 27
Alice | 23
Fenced code blocks. In addition to the normal 4-space
indentation to mark code blocks, you can explicitly mark them
and supply a language (to make syntax highlighting simple). Just
mark it like this:
```go
func getTrue() bool {
return true
}
```
You can use 3 or more backticks to mark the beginning of the
block, and the same number to mark the end of the block.
Definition lists. A simple definition list is made of a single-line
term followed by a colon and the definition for that term.
Cat
: Fluffy animal everyone likes
Internet
: Vector of transmission for pictures of cats
Terms must be separated from the previous definition by a blank line.
Footnotes. A marker in the text that will become a superscript number;
a footnote definition that will be placed in a list of footnotes at the
end of the document. A footnote looks like this:
This is a footnote.[^1]
[^1]: the footnote text.
Autolinking. Blackfriday can find URLs that have not been
explicitly marked as links and turn them into links.
Strikethrough. Use two tildes (~~
) to mark text that
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.
Smart quotes. Smartypants-style punctuation substitution is
supported, turning normal double- and single-quote marks into
curly quotes, etc.
LaTeX-style dash parsing is an additional option, where --
is translated into –
, and ---
is translated into
—
. This differs from most smartypants processors, which
turn a single hyphen into an ndash and a double hyphen into an
mdash.
Smart fractions, where anything that looks like a fraction
is translated into suitable HTML (instead of just a few special
cases like most smartypant processors). For example, 4/5
becomes <sup>4</sup>⁄<sub>5</sub>
, which renders as
4⁄5.
Blackfriday is structured to allow alternative rendering engines. Here
are a few of note:
github_flavored_markdown:
provides a GitHub Flavored Markdown renderer with fenced code block
highlighting, clickable heading anchor links.
It's not customizable, and its goal is to produce HTML output
equivalent to the GitHub Markdown API endpoint,
except the rendering is performed locally.
markdownfmt: like gofmt,
but for markdown.
LaTeX output:
renders output as LaTeX.
Blackfriday-Confluence: provides a Confluence Wiki Markup renderer.
本项目是群体化方法与技术的开源实现案例,在基于Gitea的基础上,进一步支持社交化的协同开发、协同学习、协同研究等群体创新实践服务,特别是针对新一代人工智能技术特点,重点支持项目管理、git代码管理、大数据集存储管理与智能计算平台接入。 https://www.trustie.net/
Go Roff Shell Less JavaScript other
Dear OpenI User
Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.
For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》