Skip to content

Commit bca630e

Browse files
authored
Updated to include OutputPath
Minor update to the document to include OutputPath to generate README.md Closes #50
1 parent 0d9de6f commit bca630e

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,10 +137,10 @@ To run PSDocs for Azure locally use the `Invoke-PSDocument` cmdlet.
137137
Import-Module PSDocs.Azure;
138138
139139
# Generate markdown
140-
Invoke-PSDocument -Module PSDocs.Azure -InputObject '<template_file_path>';
140+
Invoke-PSDocument -Module PSDocs.Azure -InputObject '<template_file_path>' -OutputPath out/docs/;
141141
```
142142

143-
This will generate a `README.md` with the generated markdown.
143+
This will generate a `README.md` in out/docs directory with the generated markdown (also creates out/docs/ directory if it does not exist).
144144

145145
### Scanning for templates
146146

0 commit comments

Comments
 (0)