Commit Graph

57 Commits (master)

Author SHA1 Message Date
Dmitri Shuralyov e96880f42b
README: make a definitive decision on v2 import path
This change makes it clear that the v2 import path
is github.com/russross/blackfriday/v2, and updates
various links accordingly.

See https://github.com/russross/blackfriday/issues/587#issuecomment-703393820 for details.

This change also converges the README for v1 and v2
to be consistent, as they've started to drift apart.
(See PR #675 for the equivalent change to the README
on v2 branch.)

For #587.

GitHub-Pull-Request: #674
2020-10-26 23:46:40 -04:00
Anatoly Milkov a925a152c1 README: update URL of LaTeX renderer (#465)
It has moved from Bitbucket, first to GitHub, then to GitLab.
Point to its latest location.

Updates #388.
2019-06-16 15:52:46 -04:00
Christian Oliff f3ccc8fc06 https link to GitHub (#538) 2019-04-17 22:17:06 +03:00
Iskander (Alex) Sharipov 13768b07fa readme: use fenced code blocks (#519)
It's more consistent and it's possible to mark code blocks with "go" hint,
so we get syntax highlighting on GitHub.
2019-01-20 20:42:03 +02:00
Vytautas Šaltenis 46c73eb196
Add a link to bfchroma, glue library with Chroma (#400)
Chroma is a general purpose code highlighting library, and bfchroma
provides an easy to use glue layer for Blackfriday to interface with
Chroma.

Fixes #10.
2018-08-04 13:11:49 +03:00
Yoshiya Hinosawa 16ac584625 docs(README.md): fix typo (#451) 2018-04-26 21:50:03 +03:00
Vas Sudanagunta e32caebbc7
Fix broken link to v2 in README 2018-02-07 15:16:47 -05:00
Vytautas Šaltenis 8249792ba8 Update on import paths and dep transitive import FAQ
Update usage and import paths with and without package management.
Document the dep transitive dependency issue and how to get around it.
Couple more minor edits.
2017-10-07 12:41:58 +03:00
Vytautas Šaltenis 8ad7e40db0 Update README with the latest changes from v2 2017-10-07 11:14:28 +03:00
Vytautas Šaltenis a03b7ee643 Add v1 import path, fix Bluemonday code snippet 2017-10-07 11:14:28 +03:00
Vytautas Šaltenis 52dd06192f Badges back to heading, reference v1 docs explicitly 2017-10-07 11:14:28 +03:00
Vytautas Šaltenis ad4c953876 Put row of badges above the top level heading 2017-10-07 11:14:28 +03:00
Vytautas Šaltenis 74be510331 Document V2 in master README 2017-10-07 11:14:28 +03:00
Dmitri Shuralyov 0ba0f2b6ed Document SanitizedAnchorName algorithm, copy implementation. (#352)
The goal of this change is to reduce number of non-standard library
packages (repositories) that blackfriday imports from 1 to 0, and in
turn, reduce the cost of importing blackfriday into other projects.

Do so by documenting the algorithm of SanitizedAnchorName, and include
a copy of the small function inside blackfriday itself. The same
functionality continues to be available in the original location,
github.com/shurcooL/sanitized_anchor_name.Create. It can be used by
existing users and those that look for a small package, and don't need
all of blackfriday functionality. Existing users of blackfriday can use
the new SanitizedAnchorName function directly and avoid an extra
package import.

Resolves #350.
2017-05-09 02:07:14 -04:00
Kévin Dunglas 5f33e7b787 Document using fenced code blocks with bluemonday (#309)
Document using fenced code blocks with bluemonday
2016-10-03 19:27:22 +03:00
Dmitri Shuralyov fc997ac2ba Travis: Run gofmt -s, go vet, go test -race, add Go 1.6.
Also make tip a fast-finish allowed failure. That way, if CI fails on
tip due to a temporary issue with tip, it will not break build status.
However, it's still possible to see tip build status by looking at CI
details page.

Do not run go vet with Go 1.4 or older since it's not included in the
standard library, and it's no longer available in external standard
library.

Add godoc badge to README.md.
2016-04-28 22:47:04 -07:00
Shawn Smith 1d94959fea fix typo 2016-03-16 15:21:50 +09:00
Alex Yatskov 7d22880556 Adding a link to Md2Vim. 2015-11-17 12:58:23 +09:00
nitoyon 6a7bd0d6e9 README: Add 'Definition lists' and 'Footnotes' 2015-10-31 00:50:10 +09:00
Dmitri Shuralyov 10880f66e2 README: Update import path of github_flavored_markdown package.
It has moved out into a standalone repo recently. See shurcooL/go#19 for rationale.
2015-05-25 11:54:26 -07:00
Dmitry Chestnykh ef9974b1b7 README: rename libupskirt to Sundown.
The original upskirt library by Natacha Porté has been renamed to
libsoldout, while the fork of it that was located at tanoku/upskirt has
been renamed to Sundown and moved to vmg/sundown. Since Blackfriday has
been started as a translation of tanoku/upskirt, rename its mention in
README to Sundown.
2015-03-24 06:35:19 +01:00
Eric Paris ec46062546 Move the license info from README to LICENSE file
It's pretty standard to have a license file, and some projects require
them before your code can be used in their code.  Move the license to
its own file.
2015-02-09 16:26:22 -05:00
Dmitri Shuralyov f4bb968b5f Minor cleanup.
Apply gofmt on html.go.
Apply goimports-compatible formatting on block.go (space between standard and third party imports).
Move Travis build status image in a more pleasing, common location.
Remove "Markdown pretty-printer output engine" from TODO steps; this is already done in markdownfmt.
Remove unneeded trailing whitespace in README.
2014-11-29 20:41:11 -08:00
Vytautas Šaltenis 8e739c7f0d Change Sanitize() to SanitizeBytes() in example 2014-09-20 14:48:01 +03:00
Vytautas Saltenis 819f70a832 Document usage of blackfriday along w/ bluemonday 2014-09-19 21:26:22 +03:00
Vytautas Šaltenis c50c511603 More Travis stuff: better go get, plus build badge 2014-08-30 00:10:33 +03:00
Vytautas Šaltenis 52f7a2a7b0 Fix misleading wording in README
Fixes #103.
2014-08-21 14:05:37 +03:00
Dmitri Shuralyov 51cf25db16 Add a reference to github_flavored_markdown in README. 2014-07-04 18:10:34 -07:00
Russ Ross 93aad334f4 Update README.md
link to markdownfmt, add note about LaTeX output
2014-05-14 13:27:37 -06:00
Jeff Paine d55bbf4b7b Add Usage heading 2014-05-08 18:42:05 -04:00
Vytautas Šaltenis 84ee8e62f6 Add a note about JavaScript injections to README 2014-02-17 21:09:03 +02:00
Russ Ross d0e587acc8 Change GOROOT references to GOPATH in README 2013-11-21 08:47:41 -07:00
Antoine Grondin bd3e6c9492 Fix typo. 2013-09-01 10:59:06 -07:00
Russ Ross d4bdd8db21 update license language to match OSI 2013-08-14 07:43:17 -06:00
Alif Rachmawadi 227e2c0094 fix table syntax example 2013-05-05 10:35:09 +07:00
Russ Ross 82ba58501c link directly to blackfriday-tool 2012-03-07 22:12:46 -07:00
Russ Ross c317affdbc readme updates for go 1 2012-03-07 22:06:07 -07:00
Russ Ross bb8ee591d1 doc improvements, commenting 2011-07-07 11:56:45 -06:00
Russ Ross 256ff94689 readme tweak 2011-07-06 10:04:30 -06:00
Russ Ross 60cb261acc readme updates 2011-07-06 10:01:13 -06:00
Russ Ross 70c92fefd4 inline helpers put parser arg first 2011-06-29 11:21:46 -06:00
Russ Ross c969dff782 added simplified interface for common usage 2011-06-28 15:55:27 -06:00
Russ Ross fde2c60665 version number, few more options for command-line tool 2011-06-28 11:30:10 -06:00
Russ Ross 66b71b1f51 readme tweak 2011-06-27 20:15:12 -06:00
Russ Ross 4bd8627b2c README tweak 2011-06-27 20:14:13 -06:00
Russ Ross f8f70572a4 simplified BSD license 2011-06-27 20:11:32 -06:00
Russ Ross a74678bf51 enable profiling from command-line tool 2011-06-24 17:13:42 -06:00
Russ Ross c337e07e74 fraction example in readme 2011-06-24 16:42:17 -06:00
Russ Ross f9b03f67fb output validates, command-line tool has useful options 2011-06-24 11:50:03 -06:00
Russ Ross 87f1e83da2 readme updates 2011-05-31 16:31:36 -06:00