PSDocs.Azure icon indicating copy to clipboard operation
PSDocs.Azure copied to clipboard

Generate docs for Bicep modules

Open BernieWhite opened this issue 4 years ago • 4 comments

We support docs for ARM Template or Bicep via ARM template. But should also support documentation for Bicep natively.

BernieWhite avatar Jul 23 '21 12:07 BernieWhite

Is there an ETA on when native bicep support will be available? If help is required I'm open just need some guidance on where to starts :)

jeffpatton1971 avatar Mar 10 '22 22:03 jeffpatton1971

Is there an ETA on when native bicep support will be available? If help is required I'm open just need some guidance on where to starts :)

@BernieWhite Any news on this? 🙂

vegardhw avatar Jul 06 '22 13:07 vegardhw

It's not amazing but this mostly works:

bicep build file.bicep --outfile file.json
Invoke-PSDocument -Module PSDocs.Azure -InputObject file.json -OutputPath out/docs/

C0smin avatar Jan 17 '23 14:01 C0smin

It's not amazing but this mostly works:

bicep build file.bicep --outfile file.json Invoke-PSDocument -Module PSDocs.Azure -InputObject file.json -OutputPath out/docs/

Indeed, but it would be nice not to have to build yourself (and then delete the resulting JSON file). Even better would be if the parameters snippet would output bicepparam format instead of JSON.

SvenAelterman avatar Dec 27 '24 18:12 SvenAelterman