MarkdownToHtml

2.1.0

Highly configurable markdown to HTML conversion using customizable templates.

### Features

* Open Source and fully _hackable_.
* Out-of-the box support for diagrams, math typesetting and code syntax
 highlighting.
* Based on [Markdig](https://github.com/lunet-io/markdig),
 a fast, powerful, [CommonMark](http://commonmark.org/) compliant Markdown
 process
Highly configurable markdown to HTML conversion using customizable templates.

### Features

* Open Source and fully _hackable_.
* Out-of-the box support for diagrams, math typesetting and code syntax
 highlighting.
* Based on [Markdig](https://github.com/lunet-io/markdig),
 a fast, powerful, [CommonMark](http://commonmark.org/) compliant Markdown
 processor for .NET with more than 20 configurable extensions.
* High quality Open Source web components:
 - **Code Highlighting**: [highlight.js](https://highlightjs.org/); supports
   189 languages and 91 styles.
 - **Math typesetting**: [KaTeX](https://katex.org/); The fastest math
   typesetting library for the web.
 - **Diagramming**: [Mermaid](https://mermaid-js.github.io/mermaid/); Generation
   of diagrams and flowcharts from text in a similar manner as Markdown.
* Highly configurable static website projects with configuration file and build
 script. See `New-StaticHTMLSiteProject`.
* Sites can be used offline (without connection to the internet). All site
 assets are local.

### Prerequisites

To successfully create web sites from Markdown you should know:
* Markdown: A good starting point would be
 [GitHub Flavored Markdown](https://github.github.com/gfm/)
* Some knowledge about HTML and CSS (Cascading Stylesheets).
* Some PowerShell knowledge

See `about_MarkdownToHTML` for more information about configuration
and operation of this module.

### Incompatibilities

This version is incompatible with existing conversion projects
which use the _mathematics_ extensions and were created with versions of this module
older than 2.0.0 (i.e. 1.* or 0.*).

**Make sure to read the release notes for 2.0.0 below for instructions on how to upgrade your
existing conversion projects.**
Show more

Minimum PowerShell version

5.1

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name MarkdownToHtml -RequiredVersion 2.1.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name MarkdownToHtml -Version 2.1.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) 2018-2020 WetHat Lab. All rights reserved.

Package Details

Author(s)

  • WetHat

Tags

Markdown HTML Converter

Functions

Convert-MarkdownToHTML Convert-MarkdownToHTMLFragment ConvertTo-NavigationItem Find-MarkdownFiles New-StaticHTMLSiteProject New-HTMLTemplate Publish-StaticHtmlSite

PSEditions

Desktop

Dependencies

This module has no dependencies.

Release Notes

## 2.1.0

#### Enhancements

* `Publish-StaticHtmlSite` now accepts definition of custom placeholder
 mappins for expansion of `md-template.html`.
* Default template placeholder delimiters changed to `{{` and `}}`.
* Static HTML site projects added: See `New-StaticHTMLSiteProject`.
* Documentation made more `Get-Help` friendly.
* _Mermaid_ assets updated to version 8.5.0

#### Maintenance

* Minimum required Powershell version now 5.1 (Desktop)

## 2.0.0

The updated version of _Markdig_ incuded in this release introduces
an incompatiblity in the _mathematics_ extension which breaks _KaTeX_ math rendering.

See `about_MarkdownToHTML` for options to upgrade existing projects.
To address this incompaibility the KaTex configuration in **all** deployed html templates

#### New Features

* Highlighting languages _Perl_ and _YAML_ added

#### Maintenance

* Updated to _Markdig_ 0.18.0.
* KaTeX updated to version 0.11.1
* Code syntax highlighting updated to version 9.17.1

#### Bugfixes
* Rendering of math blocks now creates centered output with the correct (bigger) font.
* Changed the default html template (`md_template.html`) to address the incompatible
 change in the LaTeX math output of the _mathematics_ extension of _Markdig_.

## 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

FileList

  • MarkdownToHtml.nuspec
  • LICENSE
  • Markdig.dll
  • Markdown2HTML.png
  • MarkdownToHtml.psd1
  • MarkdownToHtml.psm1
  • MarkdownToHtml.pssproj
  • MarkdownToHtml.tests.ps1
  • README.md
  • Documentation\about_MarkdownToHTML.md
  • Documentation\Convert-MarkdownToHTML.md
  • Documentation\Convert-MarkdownToHTMLFragment.md
  • Documentation\ConvertTo-NavigationItem.md
  • Documentation\Find-MarkdownFiles.md
  • Documentation\MarkdownToHTML.md
  • Documentation\New-HTMLTemplate.md
  • Documentation\New-StaticHTMLSiteProject.md
  • Documentation\Publish-StaticHtmlSite.md
  • en\about_MarkDownToHTML.help.txt
  • obj\Debug\MarkdownToHtml.pssproj.FileListAbsolute.txt
  • obj\Debug\MarkdownToHtml.pssprojAssemblyReference.cache
  • ProjectTemplate\Build.json
  • ProjectTemplate\Build.ps1
  • ProjectTemplate\markdown\README.md
  • ProjectTemplate\Template\md-template.html
  • ProjectTemplate\Template\styles\md-styles.css
  • ReferenceData\Code.html
  • ReferenceData\KaMaid.html
  • ReferenceData\KaTex.html
  • ReferenceData\mermaid.html
  • ReferenceData\html\.gitignore
  • ReferenceData\html\Code.html
  • ReferenceData\html\KaMaid.html
  • ReferenceData\html\KaTex.html
  • ReferenceData\html\mermaid.html
  • ReferenceData\html_cust\Code.html
  • ReferenceData\html_cust\KaMaid.html
  • ReferenceData\html_cust\KaTex.html
  • ReferenceData\html_cust\mermaid.html
  • ReferenceData\html_cust\SiteContent1\Code.html
  • ReferenceData\html_cust\SiteContent2\SubFolder\mermaid.html
  • Template\md-template.html
  • Template\styles\md-styles.css
  • Template.assets\js\highlight.pack.js
  • Template.assets\js\mermaid.min.js
  • Template.assets\katex\katex.css
  • Template.assets\katex\katex.js
  • Template.assets\katex\katex.min.css
  • Template.assets\katex\katex.min.js
  • Template.assets\katex\katex.mjs
  • Template.assets\katex\README.md
  • Template.assets\katex\contrib\auto-render.js
  • Template.assets\katex\contrib\auto-render.min.js
  • Template.assets\katex\contrib\auto-render.mjs
  • Template.assets\katex\contrib\copy-tex.css
  • Template.assets\katex\contrib\copy-tex.js
  • Template.assets\katex\contrib\copy-tex.min.css
  • Template.assets\katex\contrib\copy-tex.min.js
  • Template.assets\katex\contrib\copy-tex.mjs
  • Template.assets\katex\contrib\mathtex-script-type.js
  • Template.assets\katex\contrib\mathtex-script-type.min.js
  • Template.assets\katex\contrib\mathtex-script-type.mjs
  • Template.assets\katex\contrib\mhchem.js
  • Template.assets\katex\contrib\mhchem.min.js
  • Template.assets\katex\contrib\mhchem.mjs
  • Template.assets\katex\contrib\render-a11y-string.js
  • Template.assets\katex\contrib\render-a11y-string.min.js
  • Template.assets\katex\contrib\render-a11y-string.mjs
  • Template.assets\katex\fonts\KaTeX_AMS-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_AMS-Regular.woff
  • Template.assets\katex\fonts\KaTeX_AMS-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.ttf
  • Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.woff
  • Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.woff2
  • Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Fraktur-Bold.ttf
  • Template.assets\katex\fonts\KaTeX_Fraktur-Bold.woff
  • Template.assets\katex\fonts\KaTeX_Fraktur-Bold.woff2
  • Template.assets\katex\fonts\KaTeX_Fraktur-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Fraktur-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Fraktur-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Main-Bold.ttf
  • Template.assets\katex\fonts\KaTeX_Main-Bold.woff
  • Template.assets\katex\fonts\KaTeX_Main-Bold.woff2
  • Template.assets\katex\fonts\KaTeX_Main-BoldItalic.ttf
  • Template.assets\katex\fonts\KaTeX_Main-BoldItalic.woff
  • Template.assets\katex\fonts\KaTeX_Main-BoldItalic.woff2
  • Template.assets\katex\fonts\KaTeX_Main-Italic.ttf
  • Template.assets\katex\fonts\KaTeX_Main-Italic.woff
  • Template.assets\katex\fonts\KaTeX_Main-Italic.woff2
  • Template.assets\katex\fonts\KaTeX_Main-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Main-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Main-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Math-BoldItalic.ttf
  • Template.assets\katex\fonts\KaTeX_Math-BoldItalic.woff
  • Template.assets\katex\fonts\KaTeX_Math-BoldItalic.woff2
  • Template.assets\katex\fonts\KaTeX_Math-Italic.ttf
  • Template.assets\katex\fonts\KaTeX_Math-Italic.woff
  • Template.assets\katex\fonts\KaTeX_Math-Italic.woff2
  • Template.assets\katex\fonts\KaTeX_SansSerif-Bold.ttf
  • Template.assets\katex\fonts\KaTeX_SansSerif-Bold.woff
  • Template.assets\katex\fonts\KaTeX_SansSerif-Bold.woff2
  • Template.assets\katex\fonts\KaTeX_SansSerif-Italic.ttf
  • Template.assets\katex\fonts\KaTeX_SansSerif-Italic.woff
  • Template.assets\katex\fonts\KaTeX_SansSerif-Italic.woff2
  • Template.assets\katex\fonts\KaTeX_SansSerif-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_SansSerif-Regular.woff
  • Template.assets\katex\fonts\KaTeX_SansSerif-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Script-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Script-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Script-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Size1-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Size1-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Size1-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Size2-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Size2-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Size2-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Size3-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Size3-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Size3-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Size4-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Size4-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Size4-Regular.woff2
  • Template.assets\katex\fonts\KaTeX_Typewriter-Regular.ttf
  • Template.assets\katex\fonts\KaTeX_Typewriter-Regular.woff
  • Template.assets\katex\fonts\KaTeX_Typewriter-Regular.woff2
  • Template.assets\styles\agate.css
  • Template.assets\styles\far.css
  • Template.assets\styles\tomorrow-night-blue.css
  • Template.assets\styles\vs.css
  • Template.assets\styles\vs2015.css
  • TestData\markdown\Code.md
  • TestData\markdown\KaMaid.md
  • TestData\markdown\KaTex.md
  • TestData\markdown\mermaid.md
  • TestData\markdown\SiteContent1\Code.md
  • TestData\markdown\SiteContent2\SubFolder\mermaid.md
  • TestData\ProjectConfigs\Build1.json
  • TestData\ProjectConfigs\Build2.json

Version History

Version Downloads Last updated
2.8.0 8,212 4/15/2024
2.7.1 5,681 4/24/2022
2.7.0 25 4/23/2022
2.6.1 733 1/19/2022
2.6.0 31 1/17/2022
2.5.0 3,571 7/26/2021
2.4.0 373 5/28/2021
2.3.1 108 5/20/2021
2.3.0 39 5/19/2021
2.2.2 2,087 10/12/2020
2.2.1 28 10/12/2020
2.2.0 1,259 5/2/2020
2.1.1 34 4/30/2020
2.1.0 (current version) 35 4/30/2020
2.0.0 1,451 1/12/2020
1.3.0 464 9/19/2019
1.2.8 728 4/9/2019
1.2.7 845 2/2/2019
1.2.6 1,921 2/27/2018
Show less