Skip to content

Commit b9d58d1

Browse files
committed
See docs
1 parent 4fdaa8d commit b9d58d1

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,19 @@ This project includes a .NET library that can be used to customize
5757
the rendered Markdown output. In the .NET library, attribute annotations
5858
can 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 -->

0 commit comments

Comments
 (0)