impress.js | presentation tool based on the power of CSS3 transforms and transitions in modern browsers

Microsoft OneWeek 2015 Hackthon: Markdown.MAML

This is PowerShell help system

This is the file that represent it

MAML is xml-based help format for PowerShell modules.

To edit MAML file you use separate program.

PowerShell Command help editor

You found an issue in Microsoft or 3rd party documentation. What's your options?

If it's Microsoft documentation

If 3rd party

AND has project page

AND open source

THEN you can CONTRIBUTE.

You need to EDIT MAML

If you are the module developer, it's your duty: you have to edit your documentation.

We want to address it

We want simple workflow

with 0 setup

To allow community easily contribute to ANY PowerShell documentation

We defined Markdown schema to author documentation

Markdown is easy to read and edit

It already renders by collaborative services (GitHub.com, VisualStudio.com, BitBucket.com)

and modern text editors (SublimeText, VSCode)

You generate MAML from Markdown as a build-step

You add Markdown to the source control and remove MAML from it

Build reports errors (if any) during Markdown -> MAML transformation

You can edit such documentation on GitHub in minutes, right in the browser

We dramatically simplify documentation story

To make PowerShell comunity more productive and vibrant

Powered by Impress.js