Skip to content

Instantly share code, notes, and snippets.

@ChaseFlorell

ChaseFlorell/invoke-outHtml.ps1

Last active October 9, 2015 01:31
Show Gist options
  • Save ChaseFlorell/d53c8ea2d80e4975fb8c to your computer and use it in GitHub Desktop.
Save ChaseFlorell/d53c8ea2d80e4975fb8c to your computer and use it in GitHub Desktop.
Download ZIP
A PowerShell document generator Influenced by Vegard Hamar's [Out-Html](http://poshcode.org/587)
Raw
invoke-outHtml.ps1
Import-Module MyAwesomeModule
.\out-html.ps1 -moduleName 'MyAwesomeModule' -outputDir "path\to\output"
Raw
out-html-template.ps1
@"
<!DOCTYPE html>
<html lang="en">
<head>
<title>$moduleName Documentation</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/css/bootstrap.min.css" rel="stylesheet" charset="utf-8">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<style>
.navbar-nav {
height:100%;
overflow-y: auto;
}
/* make sidebar nav vertical */
@media (min-width: 768px) {
.sidebar-nav .navbar .navbar-collapse {
padding: 0;
max-height: none;
}
.sidebar-nav .navbar ul {
float: none;
}
.sidebar-nav .navbar ul:not {
display: block;
}
.sidebar-nav .navbar li {
float: none;
display: block;
}
.sidebar-nav .navbar li a {
padding-top: 12px;
padding-bottom: 12px;
}
}
@media (min-width: 992px) {
.navbar {
width: 300px;
}
}
@media (min-width: 768px) {
.navbar {
width: 300px;
}
}
@media (min-width: 1200px) {
.navbar {
width: 300px;
}
}
.sidebar-nav .navbar-header{ float: none; }
</style>
</head>
<body>
<div class="container-fluid">
<div class="row">
<div class="col-xs-12"><h1>$moduleName</h1></div>
</div>
<div class="row">
<div class="col-sm-3">
<div class="sidebar-nav">
<div class="navbar navbar-default" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse">
<span class="sr-only">Toggle</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="visible-xs navbar-brand">click menu to open</span>
</div>
<div class="navbar-collapse collapse sidebar-navbar-collapse">
<ul class="nav navbar-nav">
"@
$progress = 0
$commandsHelp | % {
Update-Progress $_.Name 'Navigation'
$progress++
" <li class=`"nav-menu`"><a href=`"#$($_.Name)`">$($_.Name)</a></li>"
}
@'
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="col-sm-9">
'@
$progress = 0
$commandsHelp | % {
Update-Progress $_.Name 'Documentation'
$progress++
@"
<div id=`"$(FixString($_.Name))`" class="toggle_container">
<div class="page-header">
<h1>$(FixString($_.Name))</h1>
"@
$syn = FixString($_.synopsis)
if(!($syn).StartsWith($(FixString($_.Name)))){
@"
<p class="lead">$syn</p>
"@
}
@"
</div>
<div class=`"row`">
"@
if (!($_.alias.Length -eq 0)) {
@"
<div class=`"col-md-12`">
<h2> Aliases </h2>
<ul>
"@
$_.alias | % {
@"
<li>$($_.Name)</li>
"@
}
@"
</ul>
</div>
"@
}
if (!($_.syntax | Out-String ).Trim().Contains('syntaxItem')) {
@"
<div class=`"col-md-12`">
<h2> Syntax </h2>
<pre>
<code>$(FixString($_.syntax | out-string))</code></pre>
</div>
"@
}
if($_.parameters.parameter.Count -gt 0){
@"
<div class=`"col-md-12`">
<h2> Parameters </h2>
<table class="table table-striped table-bordered table-condensed">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
<th>Required?</th>
<th>Pipeline Input</th>
<th>Default Value</th>
</tr>
</thead>
<tbody>
"@
$_.parameters.parameter | % {
@"
<tr>
<td>-$(FixString($_.Name))</td>
<td>$(FixString(($_.Description | out-string).Trim()))</td>
<td>$(FixString($_.Required))</td>
<td>$(FixString($_.PipelineInput))</td>
<td>$(FixString($_.DefaultValue))</td>
</tr>
"@
}
@"
</tbody>
</table>
</div>
"@
}
$inputTypes = $(FixString($_.inputTypes | out-string))
if ($inputTypes.Length -gt 0 -and -not $inputTypes.Contains('inputType')) {
@"
<div class=`"col-md-12`">
<h2> Input Type </h2>
<div>$inputTypes</div>
</div>
"@
}
$returnValues = $(FixString($_.returnValues | out-string))
if ($returnValues.Length -gt 0 -and -not $returnValues.StartsWith("returnValue")) {
@"
<div class=`"col-md-12`">
<h2> Return Values </h2>
<div>$returnValues</div>
</div>
"@
}
$notes = $(FixString($_.alertSet | out-string))
if ($notes.Trim().Length -gt 0) {
@"
<div class=`"col-md-12`">
<h2> Notes </h2>
<div>$notes</div>
</div>
"@
}
if(($_.examples | Out-String).Trim().Length -gt 0) {
@"
<div class=`"col-md-12`">
<h2> Examples </h2>
<hr>
"@
$_.examples.example | % {
@"
<h3>$(FixString($_.title.Trim(('-',' '))))</h3>
<pre>$(FixString($_.code | out-string ).Trim())</pre>
<div>$(FixString($_.remarks | out-string ).Trim())</div>
"@
}
@"
</div>
"@
}
@"
</div>
</div>
"@
}
@'
</div>
</div>
</div>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js" ></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.4/js/bootstrap.min.js" charset="utf-8"></script>
<script>
$(document).ready(function() {
$(".toggle_container").hide();
var previousId;
if(location.hash) {
var id = location.hash.slice(1); //Get rid of the # mark
var elementToShow = $("#" + id); //Save local reference
if(elementToShow.length) { //Check if the element exists
elementToShow.slideToggle('fast'); //Show the element
elementToShow.addClass("check_list_selected"); //Add class to element (the link)
}
previousId = id;
}
$('.nav-menu a').click(function() {
$('.toggle_container').hide(); // Hide all
var elem = $(this).prop("hash");
$(elem).toggle('fast'); // Show HREF/to/ID one
history.pushState({}, '', $(this).attr("href"));
window.scrollTo(0, 0);
return false;
});
});
</script>
</body>
</html>
'@
Raw
out-html.ps1
param(
[parameter(Mandatory=$true, Position=0)] [string] $moduleName,
[parameter(Mandatory=$false, Position=1)] [string] $template = "./out-html-template.ps1",
[parameter(Mandatory=$false, Position=2)] [string] $outputDir = './help',
[parameter(Mandatory=$false, Position=3)] [string] $fileName = 'default.html'
)
function FixString ($in = ''){
if ($in -eq $null) { return }
return $in.Replace('&', '&amp;').Replace('<', '&lt;').Replace('>', '&gt;').Replace('`n', '<br>').Replace('`t', '&nbsp;&nbsp;&nbsp;&nbsp;').Trim()
}
function Update-Progress($name, $action){
Write-Progress -Activity "Rendering $action for $name" -CurrentOperation "Completed $progress of $totalCommands." -PercentComplete $(($progress/$totalCommands)*100)
}
$commandsHelp = (Get-Command -module $moduleName) | get-help -full
$commandsHelp | % {
$alias = get-alias -definition $_.Name -ErrorAction SilentlyContinue
if($alias){
$_ | Add-Member Alias $alias
}
}
$aliases = gcm -Module poshbar | % {gal -Definition $_.name -ea 0}
$totalCommands = $commandsHelp.Count
$template = Get-Content $template -raw -force
Invoke-Expression $template > "$outputDir\$fileName"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment