Skip to content

Introduction

MkDocs is a python-based static site generator that takes source files in markdown and builds beautiful, responsive, searchable websites that can be hosted anywhere.

Follow along to familiarize yourself with the command-line interface and create a simple website from scratch with a couple commands and a little markdown.

Example Modules

Here are a handful of PowerShell modules with online documentation generated using MkDocs. Check out their GitHub repos to see their mkdocs.yml configuration and how they structure their markdown files.

Posh-ACME

Screenshot of Posh-ACME website

PSAppDeployToolkit

Screenshot of PSAppDeployToolkit website

PSHTML

Screenshot of PSHTML website

PSRule

Screenshot of PSRule website

PowerVCF

Screenshot of PowerVCF website