oi-lume-utils

Custom badge Custom badge Custom badge

This is a small collection of utilities for the Lume static site generator.

Getting started

The library is published at https://deno.land/x/oi_lume_utils.

There is no top-level module, instead you should import the functions direct from the underlying module files. Generally, the main function is exported as the default, so you should be able to import as a name that suits you.

As an example, to import the CSV loader from v0.4.0 of the library, use the following import.

import csvLoader from "https://deno.land/x/oi_lume_utils@v0.4.0/loaders/csv-loader.ts";

site.loader(['.csv'], csvLoader());

For detailed usage instructions, refer to the README files located closest to the functions.

In the detailed examples, the import path is truncated for brevity. The examples can be rendered correct by setting the oi_lume_charts key appropriately in a Deno import map.

Loaders

Lume loaders allow new file types to be loaded as data or pages. See the loaders README for more details of the loaders in this repository.

Processors

Lume processors allow transformation of page content after the page is rendered. See the processors README for more details of the processors in this repository.