ReferenceBuilt-in steps

parse

Parses a data file into the data of that same file, under one key.

The parse step reads the content of a data file (YAML, JSON, XML) into the data of that same file, under one key. The file keeps its content and goes on through the workflow, so a later step can render a page from it, for instance a liquid step with a template and group-by: file.

Shape map (no group-by)
Default match **/*.{json,yml,yaml,xml}
Default workflow no

What it doesLink to this heading

The step parses the file by its extension (.yml and .yaml as YAML, .json as JSON, .xml as XML) and sets the result on the file's data under as. XML is converted as the data step converts it. Another extension fails the file:

error: packages: unsupported data file '/data/packages/a.txt': use .yml, .yaml, .json or .xml

Unlike data, the values are not site or folder data: only the file itself, and the steps it reaches, see them.

OptionsLink to this heading

Option Type Default Meaning
as string data The key of the file's data that holds the parsed value

ExampleLink to this heading

One page per JSON file of data/packages:

steps:
  packages:
    inputs: "data/packages/*.json"
    uses: parse
    with:
      as: package
  package-pages:
    needs: packages
    uses: liquid
    group-by: file
    with:
      template: package.liquid
      permalink: "packages/{{ group.files[0].data.package.name }}/"
  write:
    needs: package-pages
    uses: write

_includes/package.liquid:

<h1>{{ group.files[0].data.package.name }} {{ group.files[0].data.package.version }}</h1>

data/packages/contoso.json with {"name":"contoso","version":"1.2.0"} is written to packages/contoso/index.html.

Esc to close