Skip to main content

Introduction

This project was created to help you document and showcase your PowerShell Modules.

Instead of reinventing the wheel and failing in an area where PowerShell does not excel (frontend development), this project provides a bridge between your PowerShell Comment-Based Help and Docusaurus, a static website generator written in React, with an empahasis on ease-of-use.

This cross-technology approach allows you to focus on documenting your modules without having to worry about frontend development and maintenance, all handled by the Docusaurus community.

Some of the features you will get:

  • Website for promoting your module
  • Auto-generated Get-Help documentation
  • Support for complex multi-line Get-Help code examples
  • Authoring pages in both Markdown and PowerShell source files
  • Localization, versioning and fully indexed (Algolia) search
  • Simplified publishing (Netlify, Github Pages, etc.)
  • Dark mode

🔥 Vendor Agnostic

This module can produce vendor agnostic output for users who do not want to use Docusaurus but still want to benefit of advanced features like Get-Help Code Fence Detection. Read more...

Early Bird

Just like Docusaurus, this module is still in it's early stages. Features are deliberately kept to a minimum so we can make things work first, then make it better.

Feedback

Suggestions, bug reports, fixes and ⭐⭐⭐ welcomed at our Github repository.