puppetdoc readme markdown ignored

[ubuntu811]

Hi

I'm pretty new to puppet and trying to create the documentation for a newly created puppet module.

How do I tell Puppet that the README File in the Project is in markdown language? Right now any markdown syntax as documented inhttps://docs.puppetlabs.com/puppet/latest/reference/modules_documentation.html seems to get ignored. (As well if I name the thing README.md).

I'm running Puppet 3.5.1.

Regards,
Mirjam

[Spencer Krum]

For what it's worth, the community is trying to migrate to the puppet strings tool at this point.

https://github.com/puppetlabs/puppetlabs-strings

--
You received this message because you are subscribed to the Google Groups "Puppet Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-users/02c756e8-2972-4b9a-b587-19e6caf3be8d%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

Spencer Krum
(619)-980-7820

[Felix Frank]

Yes, and it is not clear from the post what part of Puppet is supposed to honor the markdown formatting at the moment.

To the OP: Are you using `puppet doc`? Please note that the documentation that you linked refers to documentation that is displayed on the Forge only. The `puppet doc` face expects rdoc formatting.

HTH,
Felix

On 11/21/2014 04:33 PM, Spencer Krum wrote: