MarkdownToHtml

2.7.0

A collection of PowerShell commands to convert Markdown files to static
HTML sites in various ways.

# Components packaged with this module:

| Component                                       |Version | Description
|-------------------------------------------------|--------|-----------------------------------
| [Markdig](https://github.com/lunet-io/markdig) | 0.28.1 | Fast Markdown processor for .NET
| [highlight.js](https://highlightjs.org/)        | 11.5.1 | Code syntax highlighter
| [KaTeX](https://katex.org/)                     | 0.15.3 | Math typesetting
| [Mermaid](https://mermaid-js.github.io/mermaid/) | 9.0.0 | Diagramming
| [Svgbob](https://lib.rs/crates/svgbob_cli)      | 0.6.6 | Text based diagramming

Code Syntax Highlighting (highlight.js)
:   Pre-configured code syntax highlighting languages in this package:

   | Language         | Fenced Code Block Alias
   | ---------------: | : ---------------------------------------------------
   | Bash             | bash, sh, zsh
   | C#               | csharp, cs
   | C                | c, h
   | C++              | cpp, hpp, cc, hh, c++, h++, cxx, hxx
   | Clojure          | clojure, clj
   | Clojure REPL     | clojure-repl
   | CMake            | cmake, cmake.in
   | CSS              | css
   | Diff             | diff, patch
   | DOS .bat         | dos, bat, cmd
   | F#               | fsharp, fs
   | Groovy           | groovy
   | Go               | go, golang
   | HTML/XML         | xml, html, xhtml, rss, atom, xjb, xsd, xsl, plist, svg
   | HTTP             | http, https
   | Java             | java, jsp
   | JavaScript       | javascript, js, jsx
   | JSON             | json
   | Julia            | julia
   | Julia REPL       | julia-repl
   | LaTex            | tex
   | Lisp             | lisp
   | Makefile         | makefile, mk, mak, make
   | Markdown         | markdown, md, mkdown, mkd
   | Maxima           | maxima
   | Perl             | perl, pl, pm
   | Plain Text       | plaintext, txt, text
   | PowerShell       | powershell, ps, ps1
   | Python           | python, py, gyp
   | Python REPL      | python-repl, pycon
   | R                | r
   | Rust             | rust, rs
   | SQL              | sql
   | TOML, INI        | ini, toml
   | Visual Basic.net | vbnet, vb
   | YAML             | yml, yaml

   See also [Customization](about_MarkdownToHTML.md#customization) for more
   information.

Markdown Extensions
:   Projects generated by `New-StaticHTMLSiteProject` have following
   Markdown extensions pre-configured:
   * `common`
   * `definitionlists`
   * `mathematics`
   * `diagrams`
   * `pipetables`
   * `autoidentifiers`

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.7.0

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

Install-PSResource -Name MarkdownToHtml -Version 2.7.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

WetHat

Copyright

Package Details

Author(s)

WetHat

Functions

Convert-MarkdownToHTML Convert-MarkdownToHTMLFragment Convert-SvgbobToSvg ConvertTo-NavigationItem Expand-HtmlTemplate Expand-DirectoryNavigation Find-MarkdownFiles New-PageHeadingNavigation New-SiteNavigation New-StaticHTMLSiteProject New-HTMLTemplate Publish-StaticHtmlSite Test-LocalSiteLinks Update-ResourceLinks

PSEditions

Desktop

Dependencies

This module has no dependencies.

Release Notes

Release notes for this release are at:
[Latest MarkdownToHtml Release](https://github.com/WetHat/MarkdownToHtml/releases/tag/2.7.0).
A complete list of current and historical releases is available on GitHub at:
[Releases](https://github.com/WetHat/MarkdownToHtml/releases/).

## Upgrading Custom Templates and Static Site Projects.

Unless there is a known incompatibility (see below) or you want to take
advantage of new capabilities, **no action** is needed.

Refer to
[Upgrading Custom Conversion Templates](New-StaticHTMLSiteProject.md#upgrading-custom-conversion-templates)
for custom template upgrade instructions and to
[Upgrading Static Site Projects](New-StaticHTMLSiteProject.md#upgrading-static-site-projects)
for static site upgrades.

## Known Incompatibilities

### 2.7.0 {#2.7.0}
> The fix for [issue #35](https://github.com/WetHat/MarkdownToHtml/issues/35)
> introduces an issue with `site_navigation` configurations in `Build.json`
> build configuration files which are **below** the directory tree specified in
> the `mardown_dir` option of the top-level build configuration file
> (`Build.json`). The fix now handles relative links correctly. If you have
> gotten navigation links to work by using links which are **not** relative
> to the `Build.json` file they are defined in, the no longer work.
>
> To locate these links you can use the `Test-LocalSiteLinks` function.

### 2.0.0 {#2.0.0}
> If you have have 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.*).
> The version of _Markdig_ included in this release introduces an
> incompatiblity with projects which use the _mathematics_ extension.
>
> To address this incompaibility the _KaTex_ configuration in
> **all** deployed html templates (`md_template.html`) need to be updated like so:
>
> ~~~ html
> <script>
>     // <![CDATA[
>     window.onload = function() {
>         var tex = document.getElementsByClassName("math");
>         Array.prototype.forEach.call(tex, function(el) {
>             katex.render(el.textContent, el, {
>                                                 displayMode: (el.nodeName == "DIV"),
>                                                 macros: {
>                                                             "\\(": "",
>                                                             "\\)": "",
>                                                             "\\[": "",
>                                                             "\\]": ""
>                                                         }
>                                            })
>         });
>     };
>     // ]]>
> </script>
> ~~~

FileList

MarkdownToHtml.nuspec
ReferenceData\html_p1\KaMaid.html
Template.assets\katex\contrib\mathtex-script-type.js
Template.assets\katex\fonts\KaTeX_SansSerif-Bold.ttf
ReferenceData\html_p1\KaTex.html
Template.assets\katex\contrib\mathtex-script-type.min.js
Template.assets\katex\fonts\KaTeX_SansSerif-Bold.woff
ReferenceData\html_p1\mermaid.html
Template.assets\katex\contrib\mathtex-script-type.mjs
Template.assets\katex\fonts\KaTeX_SansSerif-Bold.woff2
Debug.ps1
ReferenceData\html_p1\SiteContent1\Code.html
Template.assets\katex\contrib\mhchem.js
Template.assets\katex\fonts\KaTeX_SansSerif-Italic.ttf
HtmlFragments.psm1
ReferenceData\html_p1\SiteContent2\SubFolder\mermaid.html
Template.assets\katex\contrib\mhchem.min.js
Template.assets\katex\fonts\KaTeX_SansSerif-Italic.woff
LICENSE
ReferenceData\html_p2\KaMaid.html
Template.assets\katex\contrib\mhchem.mjs
Template.assets\katex\fonts\KaTeX_SansSerif-Italic.woff2
Markdig.dll
ReferenceData\html_p2\KaTex.html
Template.assets\katex\contrib\render-a11y-string.js
Template.assets\katex\fonts\KaTeX_SansSerif-Regular.ttf
Markdown2HTML.png
ReferenceData\html_p2\mermaid.html
Template.assets\katex\contrib\render-a11y-string.min.js
Template.assets\katex\fonts\KaTeX_SansSerif-Regular.woff
ReferenceData\html_p2\SiteContent2\SubFolder\mermaid.html
Template.assets\katex\contrib\render-a11y-string.mjs
Template.assets\katex\fonts\KaTeX_SansSerif-Regular.woff2
MarkdownToHtml.psd1
ReferenceData\html_p3\Code.html
Template.assets\katex\fonts\KaTeX_AMS-Regular.ttf
Template.assets\katex\fonts\KaTeX_Script-Regular.ttf
MarkdownToHtml.psm1
ReferenceData\html_p3\KaMaid.html
Template.assets\katex\fonts\KaTeX_AMS-Regular.woff
Template.assets\katex\fonts\KaTeX_Script-Regular.woff
MarkdownToHtml.pssproj
ReferenceData\html_p3\KaTex.html
Template.assets\katex\fonts\KaTeX_AMS-Regular.woff2
Template.assets\katex\fonts\KaTeX_Script-Regular.woff2
MarkdownToHtml.tests.ps1
ReferenceData\html_p3\logo.png
Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.ttf
Template.assets\katex\fonts\KaTeX_Size1-Regular.ttf
README.md
ReferenceData\html_p3\Svgbob.html
Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.woff
Template.assets\katex\fonts\KaTeX_Size1-Regular.woff
SiteNavigation.psm1
ReferenceData\html_p3\Svgbob1.svg
Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.woff2
Template.assets\katex\fonts\KaTeX_Size1-Regular.woff2
svgbob_cli.exe
ReferenceData\html_p3\Svgbob2.svg
Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.ttf
Template.assets\katex\fonts\KaTeX_Size2-Regular.ttf
System.Buffers.dll
ReferenceData\html_p3\SiteContent1\Code.html
Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.woff
Template.assets\katex\fonts\KaTeX_Size2-Regular.woff
System.Memory.dll
ReferenceData\html_p3\styles\agate.css
Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.woff2
Template.assets\katex\fonts\KaTeX_Size2-Regular.woff2
System.Numerics.Vectors.dll
ReferenceData\html_p3\styles\far.css
Template.assets\katex\fonts\KaTeX_Fraktur-Bold.ttf
Template.assets\katex\fonts\KaTeX_Size3-Regular.ttf
System.Runtime.CompilerServices.Unsafe.dll
ReferenceData\html_p3\styles\md-styles.css
Template.assets\katex\fonts\KaTeX_Fraktur-Bold.woff
Template.assets\katex\fonts\KaTeX_Size3-Regular.woff
vcruntime140.dll
ReferenceData\html_p3\styles\tomorrow-night-blue.css
Template.assets\katex\fonts\KaTeX_Fraktur-Bold.woff2
Template.assets\katex\fonts\KaTeX_Size3-Regular.woff2
.github\workflows\main.yml
ReferenceData\html_p3\styles\vs.css
Template.assets\katex\fonts\KaTeX_Fraktur-Regular.ttf
Template.assets\katex\fonts\KaTeX_Size4-Regular.ttf
en\about_MarkDownToHTML.help.txt
ReferenceData\html_p3\styles\vs2015.css
Template.assets\katex\fonts\KaTeX_Fraktur-Regular.woff
Template.assets\katex\fonts\KaTeX_Size4-Regular.woff
obj\Debug\MarkdownToHtml.pssproj.AssemblyReference.cache
Template\md-template.html
Template.assets\katex\fonts\KaTeX_Fraktur-Regular.woff2
Template.assets\katex\fonts\KaTeX_Size4-Regular.woff2
obj\Debug\MarkdownToHtml.pssproj.FileListAbsolute.txt
Template\styles\md-styles.css
Template.assets\katex\fonts\KaTeX_Main-Bold.ttf
Template.assets\katex\fonts\KaTeX_Typewriter-Regular.ttf
obj\Debug\MarkdownToHtml.pssprojAssemblyReference.cache
Template.assets\js\highlight.min.js
Template.assets\katex\fonts\KaTeX_Main-Bold.woff
Template.assets\katex\fonts\KaTeX_Typewriter-Regular.woff
ProjectTemplate\Build.json
Template.assets\js\mermaid.min.js
Template.assets\katex\fonts\KaTeX_Main-Bold.woff2
Template.assets\katex\fonts\KaTeX_Typewriter-Regular.woff2
ProjectTemplate\Build.ps1
Template.assets\js\mermaid.min.js.map
Template.assets\katex\fonts\KaTeX_Main-BoldItalic.ttf
Template.assets\styles\agate.min.css
ProjectTemplate\markdown\logo.png
Template.assets\katex\katex.css
Template.assets\katex\fonts\KaTeX_Main-BoldItalic.woff
Template.assets\styles\far.min.css
ProjectTemplate\markdown\README.md
Template.assets\katex\katex.js
Template.assets\katex\fonts\KaTeX_Main-BoldItalic.woff2
Template.assets\styles\tomorrow-night-blue.min.css
ProjectTemplate\Template\md-template.html
Template.assets\katex\katex.min.css
Template.assets\katex\fonts\KaTeX_Main-Italic.ttf
Template.assets\styles\vs.min.css
ProjectTemplate\Template\PageIcon.png
Template.assets\katex\katex.min.js
Template.assets\katex\fonts\KaTeX_Main-Italic.woff
Template.assets\styles\vs2015.min.css
ProjectTemplate\Template\styles\md-styles.css
Template.assets\katex\katex.mjs
Template.assets\katex\fonts\KaTeX_Main-Italic.woff2
TestData\markdown\Code.md
ReferenceData\Code.html
Template.assets\katex\README.md
Template.assets\katex\fonts\KaTeX_Main-Regular.ttf
TestData\markdown\KaMaid.md
ReferenceData\KaMaid.html
Template.assets\katex\contrib\auto-render.js
Template.assets\katex\fonts\KaTeX_Main-Regular.woff
TestData\markdown\KaTex.md
ReferenceData\KaTex.html
Template.assets\katex\contrib\auto-render.min.js
Template.assets\katex\fonts\KaTeX_Main-Regular.woff2
TestData\markdown\mermaid.md
ReferenceData\mermaid.html
Template.assets\katex\contrib\auto-render.mjs
Template.assets\katex\fonts\KaTeX_Math-BoldItalic.ttf
TestData\markdown\Svgbob.md
Template.assets\katex\contrib\copy-tex.css
Template.assets\katex\fonts\KaTeX_Math-BoldItalic.woff
TestData\markdown\SiteContent1\Code.md
ReferenceData\html\Code.html
Template.assets\katex\contrib\copy-tex.js
Template.assets\katex\fonts\KaTeX_Math-BoldItalic.woff2
TestData\markdown\SiteContent2\SubFolder\mermaid.md
ReferenceData\html\KaMaid.html
Template.assets\katex\contrib\copy-tex.min.css
Template.assets\katex\fonts\KaTeX_Math-Italic.ttf
TestData\ProjectConfigs\Build1.json
ReferenceData\html\KaTex.html
Template.assets\katex\contrib\copy-tex.min.js
Template.assets\katex\fonts\KaTeX_Math-Italic.woff
TestData\ProjectConfigs\Build2.json
ReferenceData\html\mermaid.html
Template.assets\katex\contrib\copy-tex.mjs
Template.assets\katex\fonts\KaTeX_Math-Italic.woff2
TestData\ProjectConfigs\Build3.json
ReferenceData\html_p1\Code.html

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 (current version)	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	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