Use a Markdown Wiki as Your CMS

This is a single jar (available at clojars) to add the Smeagol Markdown Wiki as a read-only repository to your website. All code lives in the smeagol.contrib namespace.

Why Markdown?

The Wiki Language Wars are over surpassed by Markdown ...at least for geeks. Since you're here on Github, you have at least a passing familiarity with Markdown the easy-to-read, easy-to-write plain text format.

That said, Smeagol is an easy to use simple wiki engine that...

Is database-free, Smeagol uses plain text files!
In Markdown format (provided by markdown-clj).
Using git to provide versioning and backup.

Using Smeagol for your Clojure-based webiste is a no-brainer. You don't need to fire up another host, pay for another database or connect another microservice. ...in fact you don't even need to use Smeagol, just fill the content directory with Markdown files and you're good to go.

Installation

All artifacts are published in clojars, include this in your Leiningen project file:

[smeagol.contrib.util "0.9.2"]

Usage

Put this in your namespace:

(:require [smeagol.contrib.util :as wiki])

...and read Markdown files directly from the ./content/ directory as HTML:

(wiki/fetch-html "TestFile")

"<h1>Oh No Not Again</h1><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p><p>The end.</p>"

Optionally, if you supply your Markdown files with metadata they'll be included. Also you can read the files in 'lisp-style' rather than 'CamelCase':

(wiki/fetch-article "test-file")

{:metadata {:author ["Mr Foo\n"], :type ["storytime"]},
 :html "<h1>Oh No Not Again</h1><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p><p>The end.</p>",
 :title "test-file"}

Notes

Based on the location of the contents Markdown data directory, there may be slight variations based on whether your system is run as a standalone webapp or Jetty WAR.

License