Build Status

An extensible static site generator written in Clojure.

Get excited (or don’t)

One more static website generator might not be the world’s most exciting development. That being said, if the following items sound like good ideas to you then you may like incise:

Examples

Of course these examples are sort of meaningless, in that Incise does not help you create content or designs—it is simply a mechanism for finding files dispatching them to functions based on file extensions. This pattern happens to be pretty powerful and batteries are included to actually make it useful too.


Configuration

Incise is primarily configured via a config file it tries to find as a resource. This file must be named incise.edn and be found in the root of your resources directory. You can override that file and pass in the -c or --config option to incise’s main function to specify an alternative location of the config file.

An example incise.edn file is included with this project as well as the incise.edn file used to generate this website.

Usage

The easiest way to use incise is with the Leiningen. Make incise.core your main by adding the following to your project.clj.

:dependencies [[incise "0.4.0"]]
:aliases {"incise" ^:pass-through-help ["run" "-m" "incise.core"]}

Let’s see what that gets us.

lein incise --help

All command line options can also be specified in your incise.edn. For instance, if you want the default log level to be :info instead of :warn.

;; In your incise.edn
:log-level :info

Which would be like running commands with the --log-level info option.

lein incise --log-level info

Methods

The default method is to serve. This launches ring powered webserver which automatically parsers files and re-parses them when they are modified. It also launches an nREPL server so clients who want one do not need to startup a separate process to have it.

lein incise
# Or to be explicit
lein incise -m serve

You can also generate all content by parsing all parsable files in the input directory using the once command.

lein incise -m once

Finally, as mentioned above, you can use your configured deployment method.

lein incise -m deploy

Extensibility

Incise has been designed to be extensible. In order to make this extensibility as broad as possible there are five different types of extensions.

  1. A parser: incise.parsers.impl.*

    Parsers are good for generating ouput files from input files. That sounds really vague, but that’s because it could be used for many things. The most common usecase is generating HTML from an input file. For instance, there is a markdown parser which takes a markdown input file and generates and html file as a result.

  2. A transformer: incise.transformers.impl.*

    Transformers are just functions that take a parse and return a parse (typically after making some change to it). They are an entirely optional feature that some parsers use when generating content (like adding layouts to HTML content). Transformers may be specified project wide via parse-defaults or per parse.

  3. A once fixture: incise.once.fixtures.impl.*

    A once fixture is used for wrapping once in with additional behaviour. For instance, if you want an asset pipleine like stefon, the incise-stefon extension adds a once fixture for precompiling assets.

  4. A middleware: incise.middlewares.impl.*

    Middlewares for the development serving mode may also be extended. incise-stefon uses this feature to add stefon’s asset-pipeline middleware.

  5. A deployer: incise.deployer.impl.*

    Deployers are used for deploying a website. They often call incise.once.core/once to first generate the site into a directory. Those generated files are then deployed by whatever means your configurated deployer uses. A git branch based deployer is included in incise.

You can read more about how extensions are found and used here on the extensibility page. This might be helpful if you are hoping to extend incise.

Default extensions

Parsers

The following default parsers are available:

Included in incise-core:

As a separate package:

Transformers

TODO

The git-branch deployer

The only deployer defined included in incise is the git-branch deployer. It makes deploying to github pages very easy.


Where are the tests?

The incise package has no tests on its own since it is just a collection of extensions and incise-core. So, there are no tests in this package but incise-core is somewhat well speced out.

What’s next?

I have been adding issues with ideas. Open an issues with your own ideas or contribute. I would love some feedback and/or collaboration!

Tips

If you find incise valuable and are feeling particularly generous you may send some BTC to the address below.

16QAD8aVDkQYqT8WehSQtfQp1xRjbwxK3Q

Insular s (ꞅ)

The s in incise logo is the insular s (ꞅ). It is sometimes found in Gaelic type.

License

Copyright © 2013 Ryan McGowan

Distributed under the Eclipse Public License, the same as Clojure.