Generate documentation in JSON

To generate reference documentation as JSON output to a file or to standard output, specify the json format when you run Strings.

Generate JSON output if you want to use the documentation in a custom application that reads JSON. By default, Strings prints JSON output to STDOUT. For details about Strings JSON output, see the Strings JSON schema.

  1. Change directory into the module: cd /modules/<MODULE_NAME>
  2. Run the command: puppet strings generate --format json . To generate JSON documentation to a file instead, use the --out option and specify a filename:
    puppet strings generate --format json --out documentation.json