Skip to content

Instantly share code, notes, and snippets.

@sirhopcount
Created February 22, 2018 09:02
Show Gist options
  • Save sirhopcount/ba03b28a6ec6d3aa459593964b6d3fd0 to your computer and use it in GitHub Desktop.
Save sirhopcount/ba03b28a6ec6d3aa459593964b6d3fd0 to your computer and use it in GitHub Desktop.
Puppet strings markdown output error

I'm using the following versions of yard and puppet strings:

$ puppet resource package yard provider=puppet_gem
package { 'yard':
  ensure => ['0.9.12'],
}

$ puppet resource package puppet-strings provider=puppet_gem
package { 'puppet-strings':
  ensure => ['1.1.1'],
}

Using the syntax documented in de the README I get the following error:

$ puppet strings generate --format markdown
Error: Could not parse application options: invalid option: --format

So I checked the options (puppet strings generate --help) and it seems --format has been replaced with --render-as. But when I try to render the documentation I get an error that it does not support markdown.

$ puppet strings generate --render-as markdown
Error: Could not parse application options: I don't know how to render 'markdown'

So is markdown output no longer supported or am I doing something wrong?

@baurmatt
Copy link

bundle exec puppet strings generate --format markdown ./lib/puppet/**/*.rb worked for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment