What's on this page

• Data
  • data.dir
  • data.ext
  • data.load
• Static
  • static.dir
  • static.target
  • static.exclude
  • static.load
  • static.mounts
  • static example

Data and static files

These options define where data files and static files are stored and how they are handled.

Data

Where data files are stored and what extensions are handled.

Supported formats: YAML, JSON, XML and CSV.

data.dir

Data source directory (data by default).

data:
  dir: data

data.ext

List of file extensions.

data:
  ext: [yaml, yml, json, xml, csv]

data.load

Enables site.data collection (true by default).

data:
  load: true

---

Static

Management of static files, copied as is (PDF, fonts, etc.).

static.dir

Static files source directory (static by default).

static:
  dir: static

static.target

Directory where static files are copied (root by default).

static:
  target: ''

static.exclude

List of excluded files. Accepts globs, strings and regexes.

static:
  exclude: ['sass', 'scss', '*.scss', 'package*.json', 'node_modules']

static.load

Enables site.static collection (false by default).

static:
  load: false

static.mounts

Copies specific files or directories to a specific destination: each entry maps a source path, relative to the static.dir directory, to a destination path, relative to the output directory.

static:
  mounts:
    <source>: <destination>

static example

static:
  dir: docs
  target: docs
  exclude: ['sass', '*.scss', '/\.bck$/']
  load: true
  mounts:
    source/path/file.ext: dest/path/file.ext
    vendor/icons/fonts: fonts

---