ojob.io/doc

Usage

ojob ojob.io/doc job=abc.yaml name=ojob.io/abc mdfile=abc_extra.md output=abc.md html=abc.html 

Description

Generates a markdown output for an oJob. If a markdown file (.md) with the same name of the original oJob file (.yaml or .json) being processed exists it will append that markdown content on the generated one.

Expects

Name Description
job The file path to the ojob file.
name Optionally force the name of the ojob (defaults to the job argument).
mdfile Specifies the extra markdown file to append to the generated markdown (defaults to the job argument replacing the extension by ".md")
output If defined the output will be stored on the provided filepath.
html If defined the output will be stored additionally, in html, on the provided filepath.