jmtd/hakyll-ikiwiki

Code for converting IkiWiki sites to Hakyll

Hakyll-IkiWiki

Experimental code for interpreting IkiWiki-format wiki-links and directives in a Hakyll site.

I'm exploring whether/how easily I could migrate from IkiWiki to Hakyll. I'm keen to continue to use the IkiWiki link syntax ([[example]]), as well as some of the features that are obtained via plugins via directives ([[!example label=value]]), and IkiWiki's link-resolving logic.

The wikilink-and-directive finding is implemented as a Parsec parser, that should run prior to the content being passed to Pandoc. This can't easily be achieved with a Pandoc filter (operating on the Pandoc AST) because the tokens we want might be split up across any kind of different text nodes. The approach we use is to substitute, where possible, the link syntax with a HTML link. Pandoc then later will interpret the result. This means that thing will only work if the underlying markup language supports in-line HTML. Markdown does, Textile does, HTML obviously does, restructuredText does not.

I've begun implementing logic for some IkiWiki plugins in the Directive handling. Presently they can generate plain text or updated Metadata. I still need to figure out how to plumb the collated Metadata back into Hakyll.

I want to support IkiWiki's [[!template]], where possible, and plan to see if translating them into Hakyll's template tokens (e.g. $partial("filename.html")$) as inline text works or not.

Example in use

The site.hs is a simple example Hakyll program, derived from the basic template that hakyll-init generates for you. I've trimmed it a little bit and integrated IkiWiki.hs into it. The content in css and images is unchanged; posts has blog posts that demonstrate IkiWiki-style interlinks and directives in use.

hakyll-ikiwiki.cabal and stack.yaml are (for now) specific to this demonstration. You can use either Haskell Stack or Cabal to build the demo site.

hakyll-ikiwiki's Issues

merge tags from IkiWiki with those from front-matter

instead of over-writing, handle merging the lists of tags

move integration boilerplate into an exported function

This stuff can probably be hoisted into a utility function

 37         compile $ do
 38             body <- getResourceBody
 39             let (body', md) = handleWikiLinks (itemBody body)
 40             let metadataCtxs =
 41                  map (\(k,v) -> constField k v) (M.toList md)
 42             let ctx = (mconcat metadataCtxs) `mappend` (postCtxWithTags tags)
 43             do
 44                 renderPandoc (itemSetBody body' body)

derive date(s) from file {c.m}time if metadata missing

This should not be a fatal error if it's missing, but instead derive from the file mtime (or ctime)

test suite (clone IkiWiki's?)

implement IkiWiki linking rules for resolving wikilink targets

publish rendered template site to github pages

translate IkiWiki templates into Hakyll templates/partials/etc

an initial experiment would be whether [[!template id=foo]] could be substituted for $foo$ or $partial(foo.html)$.

IkiWiki-style friendly URIs (foo/bar/index.html etc.)

this isn't hard but I need to port it into the demo site