File tree Expand file tree Collapse file tree 1 file changed +13
-0
lines changed
Expand file tree Collapse file tree 1 file changed +13
-0
lines changed Original file line number Diff line number Diff line change @@ -57,6 +57,19 @@ This project includes a .NET library that can be used to customize
5757the rendered Markdown output. In the .NET library, attribute annotations
5858can be used by adding the ` Bicep.LocalDeploy ` library to your project.
5959
60+ To add the library to your project, simply run the following command:
61+
62+ ``` bash
63+ dotnet add package Bicep.LocalDeploy
64+ ```
65+
66+ There are four attributes that you can add as annotation attribute:
67+
68+ - ` [BicepDocMetadataAttribute] ` : Adds documentation metadata (YAML front matter) as key/value pairs.
69+ - ` [BicepMetadataAttribute] ` : Adds model metadata as key/value pairs for the generator to consume.
70+ - ` [BicepDocExampleAttribute] ` : Adds example blocks (title, description, code[ , language] ).
71+ - ` [BicepDocCustomAttribute] ` : Adds custom sections (title, description, body) to the output.
72+
6073## Contributing
6174
6275<!-- TODO: Add contributing.md -->
You can’t perform that action at this time.
0 commit comments