MarkdownToHtml

1.3.0

MarkdownToHtml.psd1

                                #

# Module manifest for module 'MarkDownToHTML'

#

# Generated by: WetHat

#

# Generated on: 11/7/2017 7:57:32 AM

#

@{

# Script module or binary module file associated with this manifest.

RootModule = 'MarkdownToHtml.psm1'

# Version number of this module.

ModuleVersion = '1.3.0'

# ID used to uniquely identify this module

GUID = 'ac6c6204-4097-4693-ba7e-3e0167383c24'

# Author of this module

Author = 'WetHat'

# Company or vendor of this module

CompanyName = 'WetHat Lab'

# Copyright statement for this module

Copyright = '(c) 2018-2019 WetHat Lab. All rights reserved.'

# Description of the functionality provided by this module

Description = @'

Highly configurable markdown to HTML conversion using customizable templates.

Markdown to HTML conversion is based on [Markdig](https://github.com/lunet-io/markdig),

a fast, powerful, [CommonMark](http://commonmark.org/) compliant,

extensible Markdown processor for .NET.

# Quickstart

The typical use case is to convert a bunch of Markdown files in a directory

to a static Html site using [`Convert-MarkdownToHtml`](Convert-MarkdownToHtml.md).

If the Html default conversion template is not sufficient a custom template

can be generated with [`New-HtmlTemplate`](New-HtmlTemplate).

If the converter pipeline need to be modified to meet the needs of

a special process, the converter pipeline can be custom built using:

* [`Find-MarkdownFiles`](Find-MarkdownFiles.md)

* [`Convert-MarkdownToHtmlFragment`](Convert-MarkdownToHtmlFragment.md)

* [`Publish-StaticHtmlSite`](Publish-StaticHtmlSite.md)

# Preinstalled Markdown Extensions

Following additional extensions are installed with this module:

* **Code syntax highlighting** based on the [highlight.js](https://highlightjs.org/)

  JavaScript library which supports 185 languages and 89 styles as well as

  automatic language detection. Code syntax highlighting is activated by default

  and configured for following languages:

  * Bash

  * C#

  * C++

  * Clojure

  * CMake

  * CSS

  * Diff

  * DOS .bat

  * F#

  * Groovy

  * HTML/XML

  * HTTP

  * Java

  * JavaScript

  * JSON

  * Lisp

  * Makefile

  * Markdown

  * Maxima

  * Python

  * PowerShell

  * SQL

  To obtain syntax highlighting for other/additional languages, please visit

  the [Getting highlight.js](https://highlightjs.org/download/) page and

  get a customized version of highlight.js configured for the languages

  you need.

* **Diagramming** based on the [mermaid](https://mermaidjs.github.io/) diagram

  and flowchart generator. Diagramming is pre-installed and activated.

* **LaTeX Math typesetting** based on the [KaTeX](https://katex.org/) LaTeX Math

  typesetting library. Math typesetting is pre-installed and activated

# Other Open Source Markdown to HTML Converters

* [MkDocs](https://www.mkdocs.org/) - A fast and simple static site generator

  that is geared towards building project documentation.

  Documentation source files are written in Markdown, and configured with a

  single YAML configuration file.

'@

# Minimum version of the Windows PowerShell engine required by this module

# PowerShellVersion = ''

# Name of the Windows PowerShell host required by this module

# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module

# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module

# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module

# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module

# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module

# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module

RequiredAssemblies = @('Markdig.dll')

# Script files (.ps1) that are run in the caller's environment prior to importing this module.

# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module

# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module

# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess

# NestedModules = @()

# Functions to export from this module

FunctionsToExport = @(

                       'Publish-StaticHtmlSite'

                       'Find-MarkdownFiles'

                       'Convert-MarkdownToHTMLFragment'

                       'Convert-MarkdownToHTML'

                       'New-HTMLTemplate'

                     )

# Cmdlets to export from this module

CmdletsToExport = '*'

# Variables to export from this module

VariablesToExport = '*'

# Aliases to export from this module

AliasesToExport = '*'

# List of all modules packaged with this module

ModuleList = @('MarkdownToHtml')

# List of all files packaged with this module

FileList = @(

              'MarkdownToHtml.psm1'

              'Markdig.dll'

            )

# Private data to pass to the module specified in RootModule/ModuleToProcess

PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.

        Tags = @(

                  'Markdown'

                  'HTML'

                  'Converter'

                )

        # A URL to the license for this module.

        LicenseUri = 'https://github.com/WetHat/MarkdownToHtml/blob/master/LICENSE'

        # A URL to the main website for this project.

        ProjectUri = 'https://github.com/WetHat/MarkdownToHtml'

        # A URL to an icon representing this module.

        IconUri = 'https://upload.wikimedia.org/wikipedia/commons/2/2f/PowerShell_5.0_icon.png'

        # ReleaseNotes of this module

        ReleaseNotes = @'

## 1.3.0

* upgrade of markdig to version 0.17.2

* KaTex upgraded to 0.11.0

* Re-factored the Markdown converter pipeline and made it parts public

  to make it useful for a broader range of Markdown conversion scenarios.

## 1.2.8

* `Write-Host` replaced by the more benign `Write-Verbose`

* Minor code cleanup

## 1.2.7

* Empty lines allowed im 'md-template.html` to remove an ugly but harmless

  exception.

* Syntax highlighting updated to version 9.14.2

* Upgrade to markdig version 0.15.7

* Added Resources and configuration for the [mermaid](https://mermaidjs.github.io/) diagram and

  flowchart generator version 8.0.0 to the HTML template.

* Added Resources and configuration for the [KaTeX](https://katex.org/) LaTeX Math

  typesetting library version 0.10.0 to the HTML template.

* Documentation improved.

## 1.2.6

* Powershell Gallery metadata added.

## 1.2.4

* Replaced `[System.Web.HttpUtility]` by `[System.Net.WebUtility]` to fix issue

  when powershell is run with `-noprofile`

## 1.2.3

* Fixed regression introduced in 1.2.2

* Regression test setup

## 1.2.2

* Support for markdown files in a directory hierarchy fixed.

  (directory scanning fixed and relative path added to resource links)

## 1.2.1

Handle partially HTML encoded code blocks

## 1.2.0

* Replaced XML template processing with text based template processing,

  to relax constraints on the HTML fragment quality.

* HTML encode text in `<code>` blocks

## 1.1.0

* Setting of Markdown parser options implemented

* Wildcard support for pathes added

## 1.0.0

Initial Release

'@

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module

HelpInfoURI = 'https://github.com/WetHat/MarkdownToHtml/blob/master/Documentation/MarkdownToHTML.md'

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.

# DefaultCommandPrefix = ''

}