bamboo-plugin-highlight: A highlight middleware

[ library, web ] [ Propose Tags ]

It uses highlighting-kate to highlight any code inside pre / code with a class attribute hinting the language. It's a proper middleware that works on any html document.

[Skip to Readme]




Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


  • No Candidates
Versions [RSS] 2009.6.9, 2009.7.5
Change log
Dependencies bamboo (>=2009.6.9), base (>=4 && <5), bytestring, hack (>=2009.5.19), hack-contrib (>=2009.6.9), highlighting-kate, hxt, mps (>=2009.5.13), xhtml [details]
License LicenseRef-GPL
Author Wang, Jinjing
Maintainer Wang, Jinjing <>
Category Web
Home page
Uploaded by JinjingWang at 2009-07-05T01:31:43Z
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 1806 total (6 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for bamboo-plugin-highlight-2009.7.5

[back to package description]


<pre class="haskell"><code>print "hello"</code></pre>

will highlight code as haskell source, for that the value of class attribute of pre element is haskell.


a syntax highlighter middleware

note, do not use this on rss feed, i.e.

make a middleware in your hack middleware chain:

none_rss_highlight :: Middleware
none_rss_highlight app = \env -> do
  if env.path_info.ends_with "rss.xml" 
    then app env
    else highlight app env

and use this!


underneath, it's just highlighting-kate, so grab those css.

Add them to config/theme/blueprint.txt, e.g.

css        = screen, blueprint-wp, highlight/ascetic, hk-kate, custom

also customized in custom, if you want, e.g.

/* highlight */
table.sourceCode {
  border-top: 1px solid #eee;
  padding-top: 20px;
  padding-bottom: 20px;
  margin-bottom: 20px;
  border-bottom:  1px solid #eee;
  border-left: 5px solid #eee;
  border-right: 0;
  width: 530px;

td.lineNumbers { 
  display: none;

sample main:

module Main where

import Hack.Contrib.Middleware.Debug
import Bamboo
import Bamboo.Theme.Blueprint
import Bamboo.Plugin.Highlight
import Hack
import Hack.Contrib.Middleware.BounceFavicon
import Hack.Contrib.Middleware.ContentLength
import Hack.Contrib.Middleware.ContentType
import Hack.Contrib.Middleware.ETag
import Hack.Contrib.Middleware.ShowExceptions
import Hack.Contrib.Middleware.ShowStatus
import Hack.Contrib.Middleware.Static
import Hack.Contrib.Utils
import Hack.Contrib.Middleware.URLMap
import Hack.Handler.Happstack
import qualified Hack.Contrib.Middleware.Head as H

import MPSUTF8
import Prelude hiding ((.), (>))

default_content_type :: String
default_content_type = "text/plain; charset=UTF-8"

stack :: [Middleware]
stack = 
  [  dummy_middleware

  -- filter
  ,  bounce_favicon

  -- completeness
  ,  content_length
  ,  content_type default_content_type
  ,  etag

  -- debuging
  ,  show_exceptions Nothing
  ,  show_status

  -- optimization
  ,  H.head

  , url_map [("", bamboo)]
    bamboo = use 
      [bamboo_serve, no_rss, bamboo_with_theme blueprint] dummy_app
    bamboo_serve = static (Just "db/public") 
        ["/theme", "/images", "/plugin", "/favicon.ico", "/media"]
    no_rss app = \env -> do
      if env.path_info.ends_with "rss.xml" 
        then app env
        else highlight app env

app :: Application
app = use stack dummy_app

main :: IO ()
main = run app