@11ty/eleventy (main)

# fn()

# restart()

Restarts Eleventy.

# this.fileSystemSearch()

# ...args(input, output, options, eleventyConfig)

Parameters

# ConfigInitialized()

# configPath()

# directories()

# errorHandler()

# executeBuild()

tbd.

# getVersion()

Reads the version of Eleventy.

# getVersion()

# init()

Starts Eleventy.

# initializeEnvironmentVariables()

Set process.ENV variables for use in Eleventy projects

# input()

# inputDir()

# inputFile()

# logFinished()

Logs some statistics after a complete run of Eleventy.

# logger()

# logger(logger)

Parameters

# Map()

# MinimalCore()

Eleventy’s programmatic API

# outputDir()

# pathPrefix()

# resetConfig()

Resets the config of Eleventy.

# restart()

Restarts Eleventy.

# setDryRun(isDryRun)

Updates the dry-run mode of Eleventy.

Parameters

# setFormats(formats)

Updates the template formats of Eleventy.

Parameters

# setIgnoreInitial(ignoreInitialBuild)

Set whether or not to do an initial build

Parameters

# setIncrementalBuild(isIncremental)

Sets the incremental build mode.

Parameters

# setIncrementalFile(incrementalFile)

Set the file that needs to be rendered/compiled/written for an incremental build. This method is also wired up to the CLI --incremental=incrementalFile

Parameters

# setIsVerbose(isVerbose)

Updates the verbose mode of Eleventy.

Parameters

# setPathPrefix(pathPrefix)

Updates the path prefix used in the config.

Parameters

# setRunMode(runMode)

Updates the run mode of Eleventy.

Parameters

# this.bench()

# this.buildCount()

# this.config()

# this.eleventyConfig()

# this.isDryRun()

# this.isIncremental()

# this.isRunInitialBuild()

# this.loader()

# this.options()

# this.programmaticApiIncrementalFile()

# this.rawInput()

# this.rawOutput()

# this.runMode()

# this.runMode()

# this.source()

# this.start()

# toJSON()

Renders templates to a JSON object.

# verboseMode(value)

Parameters

# verboseMode()

# write(subtype)

Writes templates to the file system.

Parameters

# addFileToWatchQueue(changedFilePath, isResetConfig)

Parameters

# getHelp()

Shows a help message including usage.

# getHelp()

# getWatchedTargets()

Returns all watched paths

# init()

Starts Eleventy.

# initWatchDependencies()

Starts watching dependencies.

# serve(port)

Serve Eleventy on this port.

Parameters

# setIncrementalBuild(isIncremental)

Sets the incremental build mode.

Parameters

# startWatch()

Set up watchers and benchmarks.

# this.eleventyServe()

# this.watchTargets()

# watch()

Start watching files

# watcherBench()

# this.validTemplateLanguageKeys()

# criptImport()

Whether to use the module loader directly

# needsToReadFileContents()

# criptImport()

Use the module loader directly

# needsToReadFileContents()

JavaScript files defer to the module loader rather than read the files to strings

# ...args()

# permalinkNeedsCompilation()

# tokens()

# compile()

Make sure compile is implemented downstream.

Returns

Promise

# etLibrary()

# permalinkNeedsCompilation()

# ...args()

# constructor(message, originalError)

Parameters

# EleventyBaseError()

This class serves as basis for all Eleventy-specific errors.

# bus()

Provides a global event bus that modules deep down in the stack can subscribe to from a global singleton for decoupled pub/sub.

# debug()

# eOverride()

# eOverride()

# function()

# _renderFileShortcodeFn()

# _renderStringShortcodeFn()

# compile()

# ConfigInitialized()

# options.tagName()

# RenderPlugin(eleventyConfig, options)

A plugin to add shortcodes to render an Eleventy template string (or file) inside of another template. {@link https://v3.11ty.dev/docs/plugins/render/}

Parameters

# renderShortcodeFn()

# EleventyConfigError()

Errors in eleventy config.

# EleventyPluginError()

Errors in eleventy plugins.

# existsCache()

# forceReloadConfig()

Force a reload of the configuration object.

# getConfig()

Returns the config object.

# getLocalProjectConfigFile()

Normalises local project config file path.

# getPathPrefix()

Gets the current path prefix denoting the root folder the output will be deployed to

# if()

# init()

Async-friendly init method

# initializeRootConfig()

Bootstraps the config object.

# mergeConfig()

Merges different config files together.

# requireLocalConfigFile()

Fetches and executes the local configuration file

# reset()

Resets the configuration.

# resetOnWatch()

Resets the configuration while in watch mode.

# setPathPrefix(pathPrefix)

Overwrites the path prefix.

Parameters

# setProjectConfigPath(path)

Overwrites the config path.

Parameters

# TemplateConfig(customRootConfig, projectConfigPath)

Config for a template.

Parameters

# this.customRootConfig()

# this.overrides()

# UserConfig()

# uses()

# usesGraph()

# _stripDateFromSlug()

Removes dates in the format of YYYY-MM-DD from a given slug string candidate.

# ...args()

# ...args()

# _getPluginName(plugin)

Parameters

# addPlugin(plugin)

addPlugin: async friendly in 3.0

Parameters

# extensionOptions()

# getNamespacedName(name)

Parameters

# Plugin(plugin)

Parameters

# resolvePlugin(name)

Parameters

# sthroughCopy(fileOrDir, copyOptions)

Adds a path to a file or directory to the list of pass-through copies which are copied as-is to the output.

Parameters

# this.benchmarkManager()

# this.benchmarkManager.get()

# this.benchmarkManager.get()

# this.benchmarks()

# this.chokidarConfig()

# this.collections()

# this.dir()

# this.directories()

# this.directoryAssignments()

# this.errorReporting()

# this.errorReporting()

# this.events()

# this.extensionConflictMap()

# this.globalData()

# this.javascript()

# this.layoutAliases()

# this.libraryAmendments()

# this.libraryOverrides()

# this.linters()

# this.liquid()

# this.logger()

# this.nunjucks()

# this.passthroughCopies()

# this.pathPrefix()

# this.precompiledCollections()

# this.preprocessors()

# this.serverOptions()

# this.transforms()

# this.universal()

# this.virtualTemplates()

# UserConfig()

Eleventy’s user-land Configuration API

# ...args()

# ...args(type, args)

Parameters

# AsyncEventEmitter()

This class emits events asynchronously. Note that Eleventy has two separate event emitter instances it uses: 1. a userland one (UserConfig.js) 2. a global one for internals (EventBus.js)

# ConsoleLogger()

Logger implementation that logs to STDOUT.

# error(msg)

Parameters

# forceLog(msg)

Parameters

# info(msg)

Parameters

# log(msg)

Parameters

# logWithOptions(options)

Parameters

# message(message, type, chalkColor, forceToConsole)

Formats the message to log.

Parameters

# warn(msg)

Parameters

# this.callbacks()

# this.plugins()

# this.posthtmlProcessOptions()

# isUseAll()

# encoding()

# loadContents()

# function(config)

Default configuration object factory.

Parameters

# function(config)

Extended default configuration object factory.

Parameters