WetHat / MarkdownToHtml

Highly configurable markdown to HTML conversion using customizable templates.

Home Page:https://wethat.github.io/MarkdownToHtml/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub release Github all releases Maintenance All Contributors

MarkdownToHtml

Highly configurable markdown to HTML conversion using customizable templates.

For a description of the module features and usage see the module documentation.

Installation and Update

This module is available on the PowerShell Gallery and can be installed from an elevated PowerShell like so:

PS> Install-Module -Name MarkdownToHTML

If the module was installed via Install-Module it can be conveniently updated from an elevated PowerShell:

PS> Update-Module -Name MarkdownToHTML

Make sure you read the release notes for information about backward compatibility.

Getting Started

To get things rolling quickly checkout the Quickstart tutorial.

Documentation

The module is documented in Markdown. This is resonably readable with the PowerShell command Get-Help.

For example:

PS> Get-Help about_MarkDownToHTML

For a richer reading experience head over to the MarkdownToHtml site and read the module documentation in HTML generated by this module. Online function documentation is available there too and can directly be opened from the command line with Get-Help like so:

PS> Get-Help New-StaticHTMLSiteProject -Online

Support

If you found an issue with the module or want to suggest and enhancement, head over to the Issues page on GitHub and submit a bug report or enhancement request. Make sure to also check the wiki for tips and the FAQ first.

See Also

  • Install-Module - Download one or more modules from an online gallery, and installs them on the local computer.
  • Update-Module - Downloads and installs the newest version of specified modules from an online gallery to the local computer.
  • PowerShellGet - a package manager for Windows PowerShell.
  • MarkdownToHtml on the Powershell Gallery.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


roose

💻

Jose Luis Ilabaca

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Highly configurable markdown to HTML conversion using customizable templates.

https://wethat.github.io/MarkdownToHtml/

License:MIT License


Languages

Language:JavaScript 82.3%Language:HTML 9.0%Language:PowerShell 6.6%Language:CSS 2.1%