Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/lume/core.ts

🔥 Static site generator for Deno 🦕
Very Popular
Go to Latest
import * as lume from "https://deno.land/x/lume@v1.16.1/core.ts";

Classes

Class to load components from the _components folder.

Class to load data files.

A directory in the src folder

Class to manage the event listeners and dispatch events

Generic Exception to throw errors. It allows to include extra data.

Class to store loaders, engines and other stuff related with different formats

Class to load _includes files.

Class to output messages to the console. If quiet mode is enabled, no messages will be output.

A page of the site

Class to load page files that generate assets (css, js, etc).

Class to prepare pages before rendering, completing the missing data

Class to store and run the (pre)processors

Class to read directories, files and store the content in a cache It's used to avoid reading the same file multiple times

The renderer is responsible for rendering the site pages in the right order and using the right template engine.

Define independent updates scopes This optimize the update process after any change

Script runner to store and run commands or execute functions It can execute the scripts and functions in parallel or sequentially

This is the heart of Lume, it contains everything needed to build the site

Scan and load files from the source folder with the data, pages, assets and static files

Class to write the generated pages and static files in the dest folder.

Interfaces

Definition used to create a new Page

The options to configure the components

The data of a page

Basic options for deno.json file

The .dest property for a Page

A directory entry

An interface used by all template engines

Error payload interface

An event object

The available options for events

A file info

The options for a template helper

Import map file

Custom events for server

The options to configure the local server

Custom events for site build

The options to configure the site build

SourceMap with a property to store dynamic sources

The .src property for a Page or Directory

The options to configure the local watcher

Custom events for server

Type Aliases

The .content property for a Page

Helper to create optional properties recursively

Event listener

A generic helper to be used in template engines

A function that loads and returns the file content

A generic Lume plugin

The method that installs a plugin

A (pre)processor

The options for a script

A script or function

The available event types

The available event types

The available event types