perun

Static site generator using Boot. Inspired by Boot task model and Metalsmith. Perun is a collection of plugins/boot tasks that you can chain together and build something custom that suits your needs.

Plugins

• markdown parser
• collections
• drafts
• calculate time to read for each page
• sitemap
• rss
• permalinks
• support rendering to any format

Example

See generated blog as an example blog.hashobject.com

Install

[perun "0.1.0-SNAPSHOT"]

Usage

Create build.boot file with similar content. For each task please specify your own options. See documentation for each task to find all supported options for each plugin.

  (set-env!
    :source-paths #{"src"}
    :resource-paths #{"resources"}
    :dependencies '[[org.clojure/clojure "1.6.0"]
                   [hiccup "1.0.5"]
                   [perun "0.1.0-SNAPSHOT"]
                   [clj-time "0.9.0"]
                   [jeluard/boot-notify "0.1.2" :scope "test"]])

  (task-options!
    pom {:project 'blog.hashobject.com
         :version "0.2.0"})

  (require '[io.perun.markdown :refer :all])
  (require '[io.perun.ttr :refer :all])
  (require '[io.perun.draft :refer :all])
  (require '[io.perun.permalink :refer :all])
  (require '[io.perun.sitemap :refer :all])
  (require '[io.perun.rss :refer :all])
  (require '[io.perun.render :refer :all])
  (require '[io.perun.collection :refer :all])

  (require '[jeluard.boot-notify :refer [notify]])

  (defn renderer [data] (:name data))

  (defn index-renderer [files]
    (let [names (map :name files)]
      (clojure.string/join "\n" names)))

  (deftask build
    "Build blog."
    []
    (comp (markdown)
          (draft)
          (ttr)
          (permalink)
          (render :renderer 'renderer)
          (collection :renderer 'index-renderer :page "index.html")
          (sitemap :filename "sitemap.xml")
          (rss :title "Hashobject" :description "Hashobject blog" :link "http://blog.hashobject.com")
          (notify)))

TODO

• robots.txt plugin
• humans.txt plugin
• amazon s3 plugin
• github webhooks plugin

Contributions

We love contributions. Please submit your pull requests.

License

Copyright © 2013-2015 Hashobject Ltd (team@hashobject.com).

Distributed under the Eclipse Public License.