Skip to content

Commit 2dcf54a

Browse files
committed
(maint) Update README.md
1 parent 25907b9 commit 2dcf54a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ To generate documentation locally, run the following command:
2626

2727
```
2828
bundle install
29-
bundle exec puppet strings generate ./lib/**/*.rb
29+
bundle exec puppet strings generate --format markdown --out REFERENCE.md
3030
```
3131

3232
This command will create a browsable \_index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.

0 commit comments

Comments
 (0)