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

x/lume/core.ts>Source

🔥 Static site generator for Deno 🦕
Very Popular
Go to Latest
class Source
Re-export
import { Source } from "https://deno.land/x/lume@v1.19.0/core.ts";

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

Constructors

new
Source(options: Options)

Properties

componentLoader: ComponentLoader

To load all components

components: { cssFile: string; jsFile: string; variable: string; }
optional
copyRemainingFiles: (path: string) => string | boolean

List of static files and folders to copy

data: Map<string, Data>

The data assigned per path

dataLoader: DataLoader

To load all _data files

extraCode: Map<string, Map<string, string>>

Extra code generated by the components

filters: ScopeFilter[]

The path filters to ignore

formats: Formats

Info about how to handle different file formats

fs: FS

Filesystem reader to scan folders

ignored: Set<string>

The list of paths to ignore

prettyUrls: boolean

Use pretty URLs

scopedComponents: Map<string, Components>

The components assigned per path

scopedData: Map<string, Data>

The data assigned per path

scopedPages: Map<string, Data[]>

The pages assigned per path

staticPaths: Map<string, { dest: string | ((path: string) => string) | undefined; dirOnly: boolean; }>

List of static files and folders to copy

Methods

addIgnoredPath(path: string)
addStaticPath(from: string, to?: string | ((path: string) => string))
build(...buildFilters: BuildFilter[]): Promise<[Page[], StaticFile[]]>

Returns the pages with extra code generated by the components