Changesets can be listed by changeset number.
The Git repository is here.
- Revision:
- 13
- Log:
Initial import of Typo 2.6.0 sources from a downloaded Tarball.
Typo is a Ruby On Rails based blog engine.
- Author:
- adh
- Date:
- Sat Jul 22 22:25:02 +0100 2006
- Size:
- 3281 Bytes
| 1 | |
| 2 | BlueCloth |
| 3 | ========= |
| 4 | |
| 5 | Version 1.0.0 - 2004/08/24 |
| 6 | |
| 7 | Original version by John Gruber <http://daringfireball.net/>. |
| 8 | Ruby port by Michael Granger <http://www.deveiate.org/>. |
| 9 | |
| 10 | BlueCloth is a Ruby implementation of [Markdown][1], a text-to-HTML conversion |
| 11 | tool for web writers. To quote from the project page: Markdown allows you to |
| 12 | write using an easy-to-read, easy-to-write plain text format, then convert it to |
| 13 | structurally valid XHTML (or HTML). |
| 14 | |
| 15 | It borrows a naming convention and several helpings of interface from |
| 16 | [Redcloth][2], [Why the Lucky Stiff][3]'s processor for a similar text-to-HTML |
| 17 | conversion syntax called [Textile][4]. |
| 18 | |
| 19 | |
| 20 | Installation |
| 21 | ------------ |
| 22 | |
| 23 | You can install this module either by running the included `install.rb` script, |
| 24 | or by simply copying `lib/bluecloth.rb` to a directory in your load path. |
| 25 | |
| 26 | |
| 27 | Dependencies |
| 28 | ------------ |
| 29 | |
| 30 | BlueCloth uses the `StringScanner` class from the `strscan` library, which comes |
| 31 | with Ruby 1.8.x and later or may be downloaded from the RAA for earlier |
| 32 | versions, and the `logger` library, which is also included in 1.8.x and later. |
| 33 | |
| 34 | |
| 35 | Example Usage |
| 36 | ------------- |
| 37 | |
| 38 | The BlueCloth class is a subclass of Ruby's String, and can be used thusly: |
| 39 | |
| 40 | bc = BlueCloth::new( str ) |
| 41 | puts bc.to_html |
| 42 | |
| 43 | This `README` file is an example of Markdown syntax. The sample program |
| 44 | `bluecloth` in the `bin/` directory can be used to convert this (or any other) |
| 45 | file with Markdown syntax into HTML: |
| 46 | |
| 47 | $ bin/bluecloth README > README.html |
| 48 | |
| 49 | |
| 50 | Acknowledgements |
| 51 | ---------------- |
| 52 | |
| 53 | This library is a port of the canonical Perl one, and so owes most of its |
| 54 | functionality to its author, John Gruber. The bugs in this code are most |
| 55 | certainly an artifact of my porting it and not an artifact of the excellent code |
| 56 | from which it is derived. |
| 57 | |
| 58 | It also, as mentioned before, borrows its API liberally from RedCloth, both for |
| 59 | compatibility's sake, and because I think Why's code is beautiful. His excellent |
| 60 | code and peerless prose have been an inspiration to me, and this module is |
| 61 | intended as the sincerest flattery. |
| 62 | |
| 63 | Also contributing to any success this module may enjoy are those among my peers |
| 64 | who have taken the time to help out, either by submitting patches, testing, or |
| 65 | offering suggestions and review: |
| 66 | |
| 67 | * Martin Chase <stillflame@FaerieMUD.org> |
| 68 | * Florian Gross <flgr@ccan.de> |
| 69 | |
| 70 | |
| 71 | Author/Legal |
| 72 | ------------ |
| 73 | |
| 74 | Original version: |
| 75 | Copyright (c) 2003-2004 John Gruber |
| 76 | <http://daringfireball.net/> |
| 77 | All rights reserved. |
| 78 | |
| 79 | Ruby version: |
| 80 | Copyright (c) 2004 The FaerieMUD Consortium |
| 81 | |
| 82 | BlueCloth is free software; you can redistribute it and/or modify it under the |
| 83 | terms of the GNU General Public License as published by the Free Software |
| 84 | Foundation; either version 2 of the License, or (at your option) any later |
| 85 | version. |
| 86 | |
| 87 | BlueCloth is distributed in the hope that it will be useful, but WITHOUT ANY |
| 88 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A |
| 89 | PARTICULAR PURPOSE. See the GNU General Public License for more details. |
| 90 | |
| 91 | |
| 92 | [1]: http://daringfireball.net/projects/markdown/ |
| 93 | [2]: http://www.whytheluckystiff.net/ruby/redcloth/ |
| 94 | [3]: http://www.whytheluckystiff.net/ |
| 95 | [4]: http://www.textism.com/tools/textile/ |
| 96 | |
| 97 | |
| 98 | $Id: README 65 2004-08-24 14:56:47Z ged $ |
| 99 | $URL: svn+ssh://svn.FaerieMUD.org/usr/local/svn/BlueCloth/trunk/README $ |
