A utility for parsing and manipulating documents with Front Matter
Branch: master
Clone or download
Latest commit 8ca3636 Jan 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__ Update to properly output Jan 11, 2018
docs Update docs Jan 11, 2018
lib Update return values Jan 11, 2018
.gitignore
README.md Updates to documentation Jan 10, 2018
package-lock.json Updates to documentation Jan 10, 2018
package.json Increment version Jan 11, 2018

README.md

Front Matter Manipulator

A utility for parsing and manipulating documents with Front Matter. Get the fields, values for any collection of documents. Bulk update, delete, or rename fields.

Getting Started

This utility can be used as a Command Line Interface, or as an import in your scripts.

It has two primary uses:

  • Parsing one or many files to discover the content model
  • Updating the content model of one or many files

This is done through the following commands:

  • fields: finds all fields in specified files
  • values: finds all values for specified fields in specified files
  • update: update the value for specified field in specified files
  • rename: update the name of specified field in specified files
  • drop: delete the specified fields from the specified files
  • convert: convert any field to an array

Installation

Install CLI

Run the following command:

npm install -g front-matter-manipulator

Install in current directory for use in scripts

npm install front-matter-manipulator --save-dev

CLI (Command Line Interface)

Front Matter Manipulator can be used on the command line to perform operations on fields.

See the documentation for each action:

Usage in node scripts/packages

Front Matter Manipulator can be used on in javascript files to perform advanced parsing or manipulation of fields.

See the documentation for each action: