https://github.com/jtom38/powerdoc
PowerShell Module to build function and class documentation.
https://github.com/jtom38/powerdoc
documentation-generator html markdown powershell powershell-module
Last synced: 12 days ago
JSON representation
PowerShell Module to build function and class documentation.
- Host: GitHub
- URL: https://github.com/jtom38/powerdoc
- Owner: jtom38
- License: mit
- Created: 2019-01-11T19:39:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-01T21:51:43.000Z (over 7 years ago)
- Last Synced: 2025-08-09T17:43:46.176Z (11 months ago)
- Topics: documentation-generator, html, markdown, powershell, powershell-module
- Language: PowerShell
- Size: 90.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PowerDoc
PowerShell Module to build function and class documentation.
## About
This project was made to make it easier for PowerShell Developers to be able to build class and function documentation easier. My goald was to add PowerDoc to the build process to document the code for public use.
## Install
TBD
## How to use
1. Import-Module PowerDoc
2. Start-PowerDoc
3. Enjoy
## Documentation Result
### Functions
Funtions will pull information from the Get-Help command and expose it in the files. Write it once as your are working on your function and PowerDoc will convert that into documntation for GitHub or on a project site with HTML files.
[Basic Example]
PowerDoc is an example of what type of files you would be able to request. Currently .md and .html files are generated. This only documents the classes and functions though, if you have more you want to add you will need to adjust your files.