MarkdownToHtml
2.8.0
HTML sites in various ways.
# Components packaged with this module:
| Component |Version | Description
|-------------------------------------------------|-------- |-----------------------------------
| [Markdig](https://github.com/lunet-io/markdig)
HTML sites in various ways.
# Components packaged with this module:
| Component |Version | Description
|-------------------------------------------------|-------- |-----------------------------------
| [Markdig](https://github.com/lunet-io/markdig) | 0.37.0 | Fast Markdown processor for .NET
| [highlight.js](https://highlightjs.org/) | 11.9.0 | Code syntax highlighter
| [KaTeX](https://katex.org/) | 0.16.10 | Math typesetting
| [Mermaid](https://mermaid-js.github.io/mermaid/) | 10.9.0 | Diagramming
| [Svgbob](https://lib.rs/crates/svgbob_cli) | 0.7.2 | Text based diagramming
## Code Syntax Highlighting (highlight.js)
Pre-configured code syntax highlighting languages in this package:
| Language | Fenced Code Block Aliases
| ---------------: | : ---------------------------------------------------
| AsciiDoc | asciidoc, adoc
| Apache | apache, apacheconf
| autoit | autoit
| Bash | bash, sh
| C# | csharp, cs, c#
| C | c, h
| C++ | cc, c++, h++, hpp, hh, hxx, cxx
| Clojure | clojure, clj, edn
| Clojure REPL | clojure-repl
| CMake | cmake, cmake.in
| CSS | css
| Diff | diff, patch
| DOS .bat | dos, bat, cmd
| Erlang |
| Erlang REPL | erlang-repl
| Excel | excel, xlsx, xls
| F# | fsharp, fs. f#
| Fortran | fortran, f90, f95
| Go | go, golang
| Graphql | graphql, gql
| Groovy | groovy
| HTTP | http, https
| INI, TOML | ini, toml
| Java | java, jsp
| JavaScript | javascript, js, jsx, mjs, cjs
| JSON | json
| Julia | julia, jldoctest
| Julia REPL | julia-repl
| Kotlin | kotlin, kt, kts
| LaTeX | latex, tex
| less | less
| Lisp | lisp
| Lua | lua
| Makefile | makefile, mk, mak, make
| Markdown | markdown, md, mkdown, mkd
| Mathematica | mathematica, mma, wl
| Maxima | maxima
| nginx | nginx, nginxconf
| Node REPL | node-repl
| Perl | perl, pl, pm
| PHP | php
| Plain Text | plaintext, txt, text
| PowerShell | powershell, pwsh, ps, ps1
| Prolog | prolog
| Properties | properties
| Python | python, py, gyp, ipython
| Python REPL | python-repl, pycon
| R | r
| Rust | rust, rs
| Scala | scala
| Scheme | scheme, scm
| scss | scss
| shell | shell, console, shellsession
| smalltalk | smalltalk, st
| SQL | sql
| tcl | tcl, tk
| Typescript | typescript, ts, tsx, mts, cts
| Visual Basic.net | vbnet, vb
| vbscript | vbscript, vbs
| vbscript-html | vbscript-html
| vim | vim
| x86asm | x86asm
| XML/HTML | xml, html, xhtml, rss, atom, xjb, xsd, xsl, plist, wsf, svg
| Xquery | xquery, xpath, xq, xqm
| 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
Owners
Copyright
(c) 2018-2022 WetHat Lab. All rights reserved.
Package Details
Author(s)
- WetHat
Tags
Markdown HTML Converter StaticHTMLSites ConversionTool
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
Dependencies
This module has no dependencies.
Release Notes
Release notes for this and previous releases are on GitHub at:
[MarkdownToHtml 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
- MarkdownToHtml.tests.ps1
- ProjectTemplate\Build.ps1
- ProjectTemplate\Template\md-template.html
- ReferenceData\html_p2\KaMaid.html
- Template.assets\js\highlight.min.js
- Template.assets\styles\far.min.css
- TestData\ProjectConfigs\Build2.json
- ReferenceData\html_p3\styles\vs2015.css
- Template.assets\katex\contrib\mhchem.js
- Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.woff
- Template.assets\katex\fonts\KaTeX_Fraktur-Regular.woff2
- Template.assets\katex\fonts\KaTeX_Main-Regular.ttf
- Template.assets\katex\fonts\KaTeX_SansSerif-Bold.woff
- Template.assets\katex\fonts\KaTeX_Script-Regular.woff2
- Template.assets\katex\fonts\KaTeX_Size4-Regular.ttf
- README.md
- ReferenceData\Code.html
- ProjectTemplate\Template\PageIcon.png
- ReferenceData\html_p2\KaTex.html
- Template.assets\js\mermaid.min.js
- Template.assets\styles\tomorrow-night-blue.min.css
- TestData\ProjectConfigs\Build3.json
- Template.assets\katex\contrib\auto-render.js
- Template.assets\katex\contrib\mhchem.min.js
- Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.woff2
- Template.assets\katex\fonts\KaTeX_Main-Bold.ttf
- Template.assets\katex\fonts\KaTeX_Main-Regular.woff
- Template.assets\katex\fonts\KaTeX_SansSerif-Bold.woff2
- Template.assets\katex\fonts\KaTeX_Size1-Regular.ttf
- Template.assets\katex\fonts\KaTeX_Size4-Regular.woff
- Debug.ps1
- SiteNavigation.psm1
- ReferenceData\KaMaid.html
- ReferenceData\html_p2\mermaid.html
- Template.assets\js\mermaid.min.js.map
- Template.assets\styles\vs.min.css
- ProjectTemplate\Template\styles\md-styles.css
- Template.assets\katex\contrib\auto-render.min.js
- Template.assets\katex\contrib\mhchem.mjs
- Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.ttf
- Template.assets\katex\fonts\KaTeX_Main-Bold.woff
- Template.assets\katex\fonts\KaTeX_Main-Regular.woff2
- Template.assets\katex\fonts\KaTeX_SansSerif-Italic.ttf
- Template.assets\katex\fonts\KaTeX_Size1-Regular.woff
- Template.assets\katex\fonts\KaTeX_Size4-Regular.woff2
- HtmlFragments.psm1
- svgbob_cli.exe
- ReferenceData\KaTex.html
- ReferenceData\html\Code.html
- ReferenceData\html_p3\Code.html
- Template.assets\katex\katex.css
- Template.assets\styles\vs2015.min.css
- ReferenceData\html_p1\SiteContent1\Code.html
- Template.assets\katex\contrib\auto-render.mjs
- Template.assets\katex\contrib\render-a11y-string.js
- Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.woff
- Template.assets\katex\fonts\KaTeX_Main-Bold.woff2
- Template.assets\katex\fonts\KaTeX_Math-BoldItalic.ttf
- Template.assets\katex\fonts\KaTeX_SansSerif-Italic.woff
- Template.assets\katex\fonts\KaTeX_Size1-Regular.woff2
- Template.assets\katex\fonts\KaTeX_Typewriter-Regular.ttf
- LICENSE
- System.Buffers.dll
- ReferenceData\mermaid.html
- ReferenceData\html\KaMaid.html
- ReferenceData\html_p3\KaMaid.html
- Template.assets\katex\katex.js
- TestData\markdown\Code.md
- ReferenceData\html_p3\SiteContent1\Code.html
- Template.assets\katex\contrib\copy-tex.js
- Template.assets\katex\contrib\render-a11y-string.min.js
- Template.assets\katex\fonts\KaTeX_Caligraphic-Regular.woff2
- Template.assets\katex\fonts\KaTeX_Main-BoldItalic.ttf
- Template.assets\katex\fonts\KaTeX_Math-BoldItalic.woff
- Template.assets\katex\fonts\KaTeX_SansSerif-Italic.woff2
- Template.assets\katex\fonts\KaTeX_Size2-Regular.ttf
- Template.assets\katex\fonts\KaTeX_Typewriter-Regular.woff
- Markdig.dll
- System.Memory.dll
- Template\md-template.html
- ReferenceData\html\KaTex.html
- ReferenceData\html_p3\KaTex.html
- Template.assets\katex\katex.min.css
- TestData\markdown\KaMaid.md
- ReferenceData\html_p3\styles\agate.css
- Template.assets\katex\contrib\copy-tex.min.js
- Template.assets\katex\contrib\render-a11y-string.mjs
- Template.assets\katex\fonts\KaTeX_Fraktur-Bold.ttf
- Template.assets\katex\fonts\KaTeX_Main-BoldItalic.woff
- Template.assets\katex\fonts\KaTeX_Math-BoldItalic.woff2
- Template.assets\katex\fonts\KaTeX_SansSerif-Regular.ttf
- Template.assets\katex\fonts\KaTeX_Size2-Regular.woff
- Template.assets\katex\fonts\KaTeX_Typewriter-Regular.woff2
- Markdown2HTML.png
- System.Numerics.Vectors.dll
- .github\workflows\main.yml
- ReferenceData\html\mermaid.html
- ReferenceData\html_p3\logo.png
- Template.assets\katex\katex.min.js
- TestData\markdown\KaTex.md
- ReferenceData\html_p3\styles\far.css
- Template.assets\katex\contrib\copy-tex.mjs
- Template.assets\katex\fonts\KaTeX_AMS-Regular.ttf
- Template.assets\katex\fonts\KaTeX_Fraktur-Bold.woff
- Template.assets\katex\fonts\KaTeX_Main-BoldItalic.woff2
- Template.assets\katex\fonts\KaTeX_Math-Italic.ttf
- Template.assets\katex\fonts\KaTeX_SansSerif-Regular.woff
- Template.assets\katex\fonts\KaTeX_Size2-Regular.woff2
- TestData\markdown\SiteContent1\Code.md
- System.Runtime.CompilerServices.Unsafe.dll
- obj\Debug\MarkdownToHtml.pssproj.AssemblyReference.cache
- ReferenceData\html_p1\Code.html
- ReferenceData\html_p3\Svgbob.html
- Template.assets\katex\katex.mjs
- TestData\markdown\mermaid.md
- ReferenceData\html_p3\styles\md-styles.css
- Template.assets\katex\contrib\mathtex-script-type.js
- Template.assets\katex\fonts\KaTeX_AMS-Regular.woff
- Template.assets\katex\fonts\KaTeX_Fraktur-Bold.woff2
- Template.assets\katex\fonts\KaTeX_Main-Italic.ttf
- Template.assets\katex\fonts\KaTeX_Math-Italic.woff
- Template.assets\katex\fonts\KaTeX_SansSerif-Regular.woff2
- Template.assets\katex\fonts\KaTeX_Size3-Regular.ttf
- ReferenceData\html_p1\SiteContent2\SubFolder\mermaid.html
- MarkdownToHtml.psd1
- vcruntime140.dll
- obj\Debug\MarkdownToHtml.pssproj.FileListAbsolute.txt
- ReferenceData\html_p1\KaMaid.html
- ReferenceData\html_p3\Svgbob1.svg
- Template.assets\katex\README.md
- TestData\markdown\Svgbob.md
- ReferenceData\html_p3\styles\tomorrow-night-blue.css
- Template.assets\katex\contrib\mathtex-script-type.min.js
- Template.assets\katex\fonts\KaTeX_AMS-Regular.woff2
- Template.assets\katex\fonts\KaTeX_Fraktur-Regular.ttf
- Template.assets\katex\fonts\KaTeX_Main-Italic.woff
- Template.assets\katex\fonts\KaTeX_Math-Italic.woff2
- Template.assets\katex\fonts\KaTeX_Script-Regular.ttf
- Template.assets\katex\fonts\KaTeX_Size3-Regular.woff
- ReferenceData\html_p2\SiteContent2\SubFolder\mermaid.html
- MarkdownToHtml.psm1
- en\about_MarkDownToHTML.help.txt
- ProjectTemplate\markdown\logo.png
- ReferenceData\html_p1\KaTex.html
- ReferenceData\html_p3\Svgbob2.svg
- Template.assets\styles\agate.min.css
- TestData\ProjectConfigs\Build1.json
- ReferenceData\html_p3\styles\vs.css
- Template.assets\katex\contrib\mathtex-script-type.mjs
- Template.assets\katex\fonts\KaTeX_Caligraphic-Bold.ttf
- Template.assets\katex\fonts\KaTeX_Fraktur-Regular.woff
- Template.assets\katex\fonts\KaTeX_Main-Italic.woff2
- Template.assets\katex\fonts\KaTeX_SansSerif-Bold.ttf
- Template.assets\katex\fonts\KaTeX_Script-Regular.woff
- Template.assets\katex\fonts\KaTeX_Size3-Regular.woff2
- TestData\markdown\SiteContent2\SubFolder\mermaid.md
- MarkdownToHtml.pssproj
- ProjectTemplate\Build.json
- ProjectTemplate\markdown\README.md
- ReferenceData\html_p1\mermaid.html
- Template\styles\md-styles.css
Version History
Version | Downloads | Last updated |
---|---|---|
2.8.0 (current version) | 9,612 | 4/15/2024 |
2.7.1 | 5,687 | 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,576 | 7/26/2021 |
2.4.0 | 373 | 5/28/2021 |
2.3.1 | 109 | 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,452 | 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 |