blackfriday/README.md

255 lines
9.1 KiB
Markdown
Raw Normal View History

2011-06-28 10:11:32 +08:00
Blackfriday
===========
2011-05-29 11:33:16 +08:00
Blackfriday is a [Markdown][1] processor implemented in [Go][2]. 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.
2011-05-29 11:33:16 +08:00
2011-06-01 06:31:36 +08:00
HTML output is currently supported, along with Smartypants
extensions. An experimental LaTeX output engine is also included.
2011-05-29 11:33:16 +08:00
It started as a translation from C of [upskirt][3].
2011-05-29 11:33:16 +08:00
Installation
------------
2012-03-08 13:06:07 +08:00
Blackfriday is compatible with Go 1. If you are using an older
release of Go, consider using v1.1 of blackfriday, which was based
on the last stable release of Go prior to Go 1. You can find it as a
tagged commit on github.
2011-05-29 11:33:16 +08:00
2012-03-08 13:06:07 +08:00
With Go 1 and git installed:
2011-05-29 11:33:16 +08:00
2012-03-08 13:06:07 +08:00
go get github.com/russross/blackfriday
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:
2012-03-08 13:06:07 +08:00
import "github.com/russross/blackfriday"
and `go get` without parameters.
2011-05-29 11:33:16 +08:00
2014-05-09 06:42:05 +08:00
Usage
-----
For basic usage, it is as simple as getting your input into a byte
slice and calling:
output := blackfriday.MarkdownBasic(input)
This renders it with no extensions enabled. To get a more useful
feature set, use this instead:
output := blackfriday.MarkdownCommon(input)
If you want to customize the set of options, first get a renderer
(currently either the HTML or LaTeX output engines), then use it to
call the more general `Markdown` function. For examples, see the
implementations of `MarkdownBasic` and `MarkdownCommon` in
`markdown.go`.
2012-03-08 13:06:07 +08:00
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
2011-05-29 11:33:16 +08:00
2012-03-08 13:06:07 +08:00
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
2012-03-08 13:12:46 +08:00
code:
* <http://github.com/russross/blackfriday-tool>
2011-05-29 11:33:16 +08:00
2012-03-08 13:06:07 +08:00
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
2012-03-08 13:06:07 +08:00
can be copied to wherever you need it without worrying about
dependencies and library versions.
2011-05-29 11:33:16 +08:00
2011-05-29 11:43:17 +08:00
Features
--------
All features of upskirt are supported, including:
2011-07-07 00:01:13 +08:00
* **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.
2011-05-29 11:43:17 +08:00
2011-07-07 00:01:13 +08:00
* **Common extensions**, including table support, fenced code
blocks, autolinks, strikethroughs, non-strict emphasis, etc.
2011-05-29 11:43:17 +08:00
2011-07-07 00:01:13 +08:00
* **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.
2011-05-29 11:43:17 +08:00
NOTE: "safety" in this context means *runtime safety only*. It is
not bullet proof against JavaScript injections, though we're working
on it (https://github.com/russross/blackfriday/issues/11 tracks the
progress).
2011-07-07 00:01:13 +08:00
* **Fast processing**. It is fast enough to render on-demand in
most web applications without having to cache the output.
2011-05-29 11:43:17 +08:00
2013-09-02 01:59:06 +08:00
* **Thread safety**. You can run multiple parsers in different
2011-06-30 01:21:46 +08:00
goroutines without ill effect. There is no dependence on global
shared state.
2011-07-07 00:01:13 +08:00
* **Minimal dependencies**. Blackfriday only depends on standard
2011-05-29 11:43:17 +08:00
library packages in Go. The source code is pretty
2011-07-07 00:01:13 +08:00
self-contained, so it is easy to add to any project, including
Google App Engine projects.
2011-05-29 11:43:17 +08:00
2011-07-07 00:01:13 +08:00
* **Standards compliant**. Output successfully validates using the
W3C validation tool for HTML 4.01 and XHTML 1.0 Transitional.
2011-05-29 11:43:17 +08:00
2011-05-29 11:33:16 +08:00
Extensions
----------
2011-07-07 00:01:13 +08:00
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.
2011-07-07 00:04:30 +08:00
* **Tables**. Tables can be created by drawing them in the input
using a simple syntax:
2011-07-07 00:01:13 +08:00
2013-05-05 11:35:09 +08:00
```
Name | Age
--------|------
Bob | 27
Alice | 23
```
2011-07-07 00:01:13 +08:00
* **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.
* **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 (it is off by
default in the `MarkdownBasic` and `MarkdownCommon` convenience
functions), newlines in the input translate into line breaks in
the output.
* **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 `&ndash;`, and `---` is translated into
`&mdash;`. 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>&frasl;<sub>5</sub>`, which renders as
2011-06-25 06:42:17 +08:00
<sup>4</sup>&frasl;<sub>5</sub>.
2011-05-29 11:33:16 +08:00
Other renderers
---------------
Blackfriday is structured to allow alternative rendering engines. Here
are a few of note:
* [github_flavored_markdown](https://godoc.org/github.com/shurcooL/go/github_flavored_markdown):
provides a GitHub Flavored Markdown renderer with fenced code block
highlighting, clickable header anchor links.
It's not customizable, and its goal is to produce HTML output
equivalent to the [GitHub Markdown API endpoint](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode),
except the rendering is performed locally.
* [markdownfmt](https://github.com/shurcooL/markdownfmt): like gofmt,
but for markdown.
* LaTeX output: renders output as LaTeX. This is currently part of the
main Blackfriday repository, but may be split into its own project
in the future. If you are interested in owning and maintaining the
LaTeX output component, please be in touch.
It renders some basic documents, but is only experimental at this
point. In particular, it does not do any inline escaping, so input
that happens to look like LaTeX code will be passed through without
modification.
2011-05-29 11:33:16 +08:00
Todo
----
* More unit testing
2011-06-01 06:31:36 +08:00
* Markdown pretty-printer output engine
* Improve unicode support. It does not understand all unicode
rules (about what constitutes a letter, a punctuation symbol,
etc.), so it may fail to detect word boundaries correctly in
some instances. It is safe on all utf-8 input.
2011-05-29 11:33:16 +08:00
2011-06-28 10:11:32 +08:00
License
-------
Blackfriday is distributed under the Simplified BSD License:
2013-08-14 21:43:17 +08:00
> Copyright © 2011 Russ Ross
> All rights reserved.
2011-06-28 10:11:32 +08:00
>
2013-08-14 21:43:17 +08:00
> Redistribution and use in source and binary forms, with or without
> modification, are permitted provided that the following conditions
> are met:
2011-06-28 10:11:32 +08:00
>
2013-08-14 21:43:17 +08:00
> 1. Redistributions of source code must retain the above copyright
> notice, this list of conditions and the following disclaimer.
2011-06-28 10:11:32 +08:00
>
2013-08-14 21:43:17 +08:00
> 2. Redistributions in binary form must reproduce the above
> copyright notice, this list of conditions and the following
> disclaimer in the documentation and/or other materials provided with
> the distribution.
2011-06-28 10:11:32 +08:00
>
2013-08-14 21:43:17 +08:00
> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
> "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
> FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
> COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
> INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
> BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
> LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
> CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
> LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
> ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
> POSSIBILITY OF SUCH DAMAGE.
2011-06-28 10:11:32 +08:00
2011-05-29 11:33:16 +08:00
[1]: http://daringfireball.net/projects/markdown/ "Markdown"
[2]: http://golang.org/ "Go Language"
[3]: http://github.com/tanoku/upskirt "Upskirt"