Commit Graph

58 Commits

Author SHA1 Message Date
Krzysztof Kowalczyk f6dcc9c3d1 add godoc badge 2018-01-26 14:59:37 -08:00
Krzysztof Kowalczyk 590d842c3d tweak readme 2018-01-26 14:58:12 -08:00
Krzysztof Kowalczyk aae1f852ba tweak docs 2018-01-26 14:57:25 -08:00
Krzysztof Kowalczyk 16d200ec12 tweak docs some more 2018-01-26 14:55:05 -08:00
Krzysztof Kowalczyk 59a376d529 fix link 2018-01-26 04:12:07 -08:00
Krzysztof Kowalczyk db85fee190 tweak readme 2018-01-26 04:08:27 -08:00
Krzysztof Kowalczyk 39c11795ca update readme.md 2018-01-26 01:12:35 -08:00
Krzysztof Kowalczyk 78bcb2da26 update links 2018-01-25 13:06:17 -08:00
Dmitri Shuralyov 187c33ff04 README: Update URL of LaTeX renderer. (#389)
It has moved from Bitbucket to GitHub.

Resolves #388.
2017-09-05 13:08:19 -04:00
Vytautas Šaltenis 19913a1b76 Address feedback 2017-07-30 19:50:50 +03:00
Vytautas Šaltenis d5487615af Several small documentation fixes 2017-07-29 11:59:03 +03:00
Vytautas Šaltenis f42ca5bf18 Merge pull request #377 from russross/v2-catch-up-readme
Catch up README with the latest changes in code
2017-07-26 21:43:53 +03:00
Vytautas Šaltenis 257ccba98f Catch up README with the latest changes in code 2017-07-09 16:27:38 +03:00
Vytautas Šaltenis 479920a987 Improve the Renderer interface
Improve Renderer to be less confusing. Fix documentation for it.

OmitContents flag got dropped along the way. First, it would fit poorly
into the new design and second, it's unclear how widely this feature is
used. But most importantly, it's trivial to roll your own with the v2
API: https://gist.github.com/rtfb/2693f6bfcc1760661e8d2fb832763a15

Fixes #368.
2017-07-09 15:44:00 +03:00
Vytautas Šaltenis e7910a813f Merge pull request #327 from russross/readme-update
Update README for v2
2017-05-06 19:33:15 +03:00
Vytautas Šaltenis 747587a52d Fix all headings wrongly referred to as headers
I've left test cases alone since can't lean on the compiler for
crosschecking there.

Fixes #330.
2017-02-12 19:05:30 +02:00
Vytautas Šaltenis f805c775f5 HTTPS allthethings! 2017-01-27 12:13:59 +02:00
Vytautas Šaltenis fb56a7e01e Update README for v2 2017-01-26 13:30:06 +02:00
Pierre Neidhardt 4688db5f6f Remove the LaTeX renderer stub and point to Ambrevar's implementation 2016-09-10 16:17:05 +05:30
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