Tag
Marks the specified directory or markdown file as part of a formula.
Usage
The GroundZero CLI uses an index.yml
file and yaml frontmatter to specify/detect which directories or markdown files belong to which formula.
Use the tag
command to generate the necessary index.yml
file or frontmatter.
g0 tag <formula-name> <path-to-dir-or-file>
For directories, the command will update or add an index.yml
file that includes metadata for the formula as such:
# GroundZero formula
formula:
name: <formula-name> # Name of formula it belongs to
For markdown files, the command will update the frontmatter to include metadata for the formula as such:
---
# Existing frontmatter
title: "Title"
description: "Description"
# GroundZero formula
formula:
name: <formula-name> # Name of formula it belongs to
---
// Markdown content
See yaml frontmatter for more details.
You can also add the frontmatter manually without using this command.
The tag
command only tags directories and markdown files for GroundZero to detect which files belong to which formula. Use the save command to save files to a formula.