README.md
October 21, 2025 ยท View on GitHub
Manages MyOwnResource resources.
Example usage
Basic MyOwnResource
Creating a basic MyOwnResource resource:
resource myOwnResource 'MyOwnResource' = {
}
If you add annotations in the following way:
```csharp
[BicepDocHeading("My Own Resource", "Example resource used to demonstrate documentation generation.")]
[BicepFrontMatter("category", "resource")]
[BicepDocExample(
"Basic deployment",
"Minimal example creating the resource.",
@"resource my 'MyOwnResource' = {
Resource: 'my-resource'
}")]
[BicepDocCustom("Custom Section", "This is a custom section.")]
// Rest of the code
```
The produces output is the following Markdown:
````markdown
<!-- myresource.md -->
---
category: "resource"
---
# My Own Resource
Example resource used to demonstrate documentation generation.
## Example usage
### Basic deployment
Minimal example creating the resource.
```bicep
resource my 'MyOwnResource' = {
Resource: 'my-resource'
}
```
## Custom Section
This is a custom section.
Contributing
Want to contribute to the project? We'd love to have you! Visit our CONTRIBUTING.md for a jump start.