An object which holds filename information. Chances are this object is something you'll never have to use, unless writing a file transform which needs to modify the output filename.

Every File instance has a info property, which is one of these guys.

An object which represents a html page, css file or javascript file (or any other file type that a transform decides to export)

An object that wraps an entity. This object has useful methods for extracting information from, and updating entities.

Do not create one of these directly; instead use quantum.select()

This object exposes the functionality that the CLI provides as an api that can be called from within your own code.

The running the build() function results in the same thing as running quantum build and the watch() function builds the site and watches for changes, in the same way that quantum watch does.

Build a quantum site using the config passed in.

Build a quantum site and watch for changes using the config passed in.

This function does not return anything as it watches files for changes and must be killed by ending the current process.

A function for parsing string containing quantum markup into JavaScript objects. The parser always returns a single entity with no type, called the root entity. The contents property of the root entity contains the content parsed content.

Reads and parses the contents of a file

Reads and parses the contents of a file

Creates a deep clone of some AST:

Converts AST back into quantum markdown. Does the opposite to parse

A file transform that converts a file with AST content into one with a JSON string as its content. This is mainly useful for debugging.

A helper api for extracting values from parsed AST. Pass in parsed AST, and use the methods on Selection to make working with the AST easier.

Writes a File to disk.

Writes an array of File to disk.

Watches a collection of files for changes. This also detects changes when inlined files are changed.

Creates a new Watcher instance that watches files for changes.

An instance of one of these is returned by quantum.watcher. It provides a way to stop watching the files. Do not create one of these directly; instead use the quantum.watcher function.