Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 102 lines (67 sloc) 3.235 kB
34e636e @sattvik Various fixes and ready for 0.9 release
authored
1 sh-clojure
2 ==========
4f69b4e @sattvik Initial commit.
authored
3
4 This is a brush used to provide syntax highlighting for Clojure with the
34e636e @sattvik Various fixes and ready for 0.9 release
authored
5 popular [SyntaxHighlighter][sh] library. It is intended as a drop-in
6 replacement of the brush developed by Travis Whitton.
7
8 [sh]: http://alexgorbatchev.com/wiki/SyntaxHighlighter
9
10
11 Features
12 --------
13
14 The key features of this brush include highlighting:
15
16 * Special forms
17 * all forms from `clojure.core` of Clojure 1.1
18 * Number, character, boolean, and nil values
19 * Strings and regular expressions
20 * Parentheses and other syntax elements such as reader macros for collections
21 and type hinting
22 * Special highlighting for quoted and unquoted symbols
23
24
25 Installation
26 ------------
27
28 In order to use this brush, you simply need to load the `shBrushClojure.js`
29 script along with the other SyntaxHighlighter files loaded by your web page.
30 For more information, see the [official installation instructions][sh-install].
31
32 [sh-install]: http://alexgorbatchev.com/wiki/SyntaxHighlighter:Usage
33
34
35 Shortcomings
36 ------------
37
38 Unfortunately, the brush is not perfect and does not support any of the following:
39
40 * Comment highlighting of `(comment …)` forms: I do not think this can be
41 accomplished with SyntaxHighlighter.
42 * Highlighting of the `(.javaMethodOrField …)` special form
43 * Special highlighting of quoted and unquoted s-expressions
44
45
0527d2a @sattvik Dual license LGPL/EPL.
authored
46 Changes
47 -------
48
49 ### Version 0.9.1 (10 April 2010)
50
51 * sh-clojure is now dual-licensed LGPL and EPL
52 * Minified brush script to reduce size by about 20%
53 * Applied some JSLint-inspired cleanup
54 * Added support for the '@' reader macro
55
56 ### Version 0.9 (7 April 2010)
57
58 * Initial release
59
34e636e @sattvik Various fixes and ready for 0.9 release
authored
60 Contact
61 -------
62
63 I welcome any feedback or patches. [The latest news about sh-clojure is
64 available from the sh-clojure page on Deep Blue Lambda.][blog-page] [The
65 source for sh-clojure is available from GitHub][github].
66
67 [blog-page]: http://www.deepbluelambda.org/programs/sh-clojure
049344a @sattvik Updated GitHub link
authored
68 [github]: http://github.com/sattvik/sh-clojure
4f69b4e @sattvik Initial commit.
authored
69
70 License
71 -------
72
0527d2a @sattvik Dual license LGPL/EPL.
authored
73 Copyright © 2010 Sattvik Software & Technology Resources, Ltd. Co.
4f69b4e @sattvik Initial commit.
authored
74
0527d2a @sattvik Dual license LGPL/EPL.
authored
75 sh-clojure may be used under the terms of either the GNU Lesser General Public
76 License (LGPL) or the Eclipse Public License (EPL). As a recipient of
77 sh-clojure, you may choose which license to receive the code under. See the
78 LICENSE file distributed with sh-clojure for details.
79
80
81 ### GNU Lesser General Public License
82
83 sh-clojure is free software; you can redistribute it and/or modify it under the
84 terms of the GNU Lesser General Public License as published by the Free
4f69b4e @sattvik Initial commit.
authored
85 Software Foundation; either version 3 of the License, or (at your option) any
86 later version.
87
0527d2a @sattvik Dual license LGPL/EPL.
authored
88 sh-clojure is distributed in the hope that it will be useful, but WITHOUT ANY
4f69b4e @sattvik Initial commit.
authored
89 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
90 PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
91 details.
92
93 You should have received a copy of the GNU Lesser General Public License along
0527d2a @sattvik Dual license LGPL/EPL.
authored
94 with sh-clojure. If not, see <http://www.gnu.org/licenses/>.
95
96
97 ### Eclipse Public License
98
99 This program and the accompanying materials are made available under the terms
100 of the Eclipse Public License v1.0 which accompanies this distribution, and is
101 available at <http://www.eclipse.org/legal/epl-v10.html>.
Something went wrong with that request. Please try again.