Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

An improved SyntaxHighlighter brush for Clojure

branch: master
README.markdown

sh-clojure

This is a brush used to provide syntax highlighting for Clojure with the popular SyntaxHighlighter library. It is intended as a drop-in replacement of the brush developed by Travis Whitton.

Features

The key features of this brush include highlighting:

  • Special forms
  • all forms from clojure.core of Clojure 1.1
  • Number, character, boolean, and nil values
  • Strings and regular expressions
  • Parentheses and other syntax elements such as reader macros for collections and type hinting
  • Special highlighting for quoted and unquoted symbols

Installation

In order to use this brush, you simply need to load the shBrushClojure.js script along with the other SyntaxHighlighter files loaded by your web page. For more information, see the official installation instructions.

Shortcomings

Unfortunately, the brush is not perfect and does not support any of the following:

  • Comment highlighting of (comment …) forms: I do not think this can be accomplished with SyntaxHighlighter.
  • Highlighting of the (.javaMethodOrField …) special form
  • Special highlighting of quoted and unquoted s-expressions

Changes

Version 0.9.1 (10 April 2010)

  • sh-clojure is now dual-licensed LGPL and EPL
  • Minified brush script to reduce size by about 20%
  • Applied some JSLint-inspired cleanup
  • Added support for the '@' reader macro

Version 0.9 (7 April 2010)

  • Initial release

Contact

I welcome any feedback or patches. The latest news about sh-clojure is available from the sh-clojure page on Deep Blue Lambda. The source for sh-clojure is available from GitHub.

License

Copyright © 2010 Sattvik Software & Technology Resources, Ltd. Co.

sh-clojure may be used under the terms of either the GNU Lesser General Public License (LGPL) or the Eclipse Public License (EPL). As a recipient of sh-clojure, you may choose which license to receive the code under. See the LICENSE file distributed with sh-clojure for details.

GNU Lesser General Public License

sh-clojure is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

sh-clojure is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with sh-clojure. If not, see http://www.gnu.org/licenses/.

Eclipse Public License

This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html.

Something went wrong with that request. Please try again.