hakyll-dir-list: Allow Hakyll to create hierarchical menues from directories.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Hakyll extension which supports the creation of hierarchical menus from source files in a directory structure. Adittionally single page web sites can created by using flattened page id's instead of urls.

[Skip to Readme]

Properties

Versions	0.1.1.0, 0.1.1.0, 1.0.0.0, 1.0.0.1, 1.0.0.2, 1.0.0.3, 1.0.0.4
Change log	CHANGELOG.md
Dependencies	base (>=4 && <5), containers, filepath, hakyll (>=4.11 && <4.12) [details]
License	BSD-3-Clause
Author	Robert Hennig <robert.hennig@freylax.de>
Maintainer	Robert Hennig <robert.hennig@freylax.de>
Category	Web
Home page	http://github.com/freylax/hakyll-dir-list
Bug tracker	http://github.com/freylax/hakyll-dir-list/issues
Uploaded	by RobertHennig at 2018-02-12T22:25:48Z

Modules

[Index]

Hakyll
- Web
  - Template
    - Hakyll.Web.Template.DirList

Downloads

hakyll-dir-list-0.1.1.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

RobertHennig

For package maintainers and hackage trustees

edit package information

Readme for hakyll-dir-list-0.1.1.0

[back to package description]

hakyll-dir-list

Build the library

stack build

Usage

The exported dirListField function is similar to the Hakyll listField template function but creates additional context information which can be used in the template to create a hierarchical menu.

Context usable inside the template

$begin-tags$ injects <li> and <ul> tags if apropriate
$end-tags$ contains the corresponding </li> and </ul> tags
$full-page-id$ is the hyphen seperated path of the page

Metainformation in the source files

For each subdirectory which should be processed one source file with the same base name should exist which can contain meta information:

pages/a.md top page for directory a
pages/a/foo.md page foo within a

The following meta information can be given

page-id part of the generated id, if not given the base name of the file
page-order give an ordering key for sorting in the current directory level, if not given the page-id will be used

Example

See the example for an illustration of usage.