Skip to content

Commit bd0e0d0

Browse files
committed
update Readme page with docs generation
1 parent 1977764 commit bd0e0d0

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,16 @@ Generated module is stored in dist folder, you can easily import it or publish i
6161
└──  TestModule.psm1
6262
```
6363

64+
### Docs Folder
65+
66+
Store `Microsoft.PowerShell.PlatyPs` generated markdown files in `docs` folder. If `docs` folder exists and contain valid markdown files, Build will generate MAML help file in the built module.
67+
68+
```
69+
 docs
70+
├──  ModuleTools.md
71+
└──  Invoke-MTBuild.md
72+
```
73+
6474
### Project JSON File
6575

6676
The `project.json` file contains all the important details about your module and is used during the module build. It should comply with a specific schema. You can refer to the sample `project-sample.json` file in the `example` directory for guidance.

0 commit comments

Comments
 (0)