https://github.com/wethat/markdowntohtml
Highly configurable markdown to HTML conversion using customizable templates.
https://github.com/wethat/markdowntohtml
html markdown markdown-converter markdowntohtml powershell-module
Last synced: 4 months ago
JSON representation
Highly configurable markdown to HTML conversion using customizable templates.
- Host: GitHub
- URL: https://github.com/wethat/markdowntohtml
- Owner: WetHat
- License: mit
- Created: 2018-02-27T11:52:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T07:28:39.000Z (over 2 years ago)
- Last Synced: 2024-04-13T21:11:47.860Z (over 2 years ago)
- Topics: html, markdown, markdown-converter, markdowntohtml, powershell-module
- Language: JavaScript
- Homepage: https://wethat.github.io/MarkdownToHtml/
- Size: 13.9 MB
- Stars: 17
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://GitHub.com/WetHat/MarkdownToHtml/releases/)
[](https://GitHub.com/WetHat/MarkdownToHtml/releases/)
[](https://GitHub.com/WetHat/MarkdownToHtml/graphs/commit-activity)
[](#contributors-)
# MarkdownToHtml
Highly configurable markdown to HTML conversion using customizable templates.
For a description of the module features and usage see the
[module documentation](https://wethat.github.io/MarkdownToHtml).
# Installation and Update
This module is available on the [PowerShell Gallery](https://www.powershellgallery.com/packages/MarkdownToHtml)
and can be installed from an elevated PowerShell like so:
```PowerShell
PS> Install-Module -Name MarkdownToHTML
```
If the module was installed via `Install-Module` it can be conveniently updated
from an elevated PowerShell:
```PowerShell
PS> Update-Module -Name MarkdownToHTML
```
Make sure you read the [release notes](https://wethat.github.io/MarkdownToHtml/index.html#latest-version)
for information about backward compatibility.
# Getting Started
To get things rolling quickly checkout the
[Quickstart](https://wethat.github.io/MarkdownToHtml/index.html#quickstart)
tutorial.
# Documentation
The module is documented in Markdown. This is resonably readable with the
PowerShell command `Get-Help`.
For example:
~~~ PowerShell
PS> Get-Help about_MarkDownToHTML
~~~
For a richer reading experience head over to the [MarkdownToHtml](https://wethat.github.io/MarkdownToHtml/index.html)
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:
~~~ PowerShell
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](https://github.com/WetHat/MarkdownToHtml/issues) page on GitHub and
submit a bug report or enhancement request. Make sure
to also check the
[wiki](https://github.com/WetHat/MarkdownToHtml/wiki) for
tips and the FAQ first.
# See Also
* [Install-Module](https://docs.microsoft.com/en-us/powershell/module/powershellget/Install-Module?view=powershell-5.1) -
Download one or more modules from an online gallery, and installs them on the local computer.
* [Update-Module](https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-5.1) -
Downloads and installs the newest version of specified modules from an online gallery to the local computer.
* [PowerShellGet](https://docs.microsoft.com/en-us/powershell/module/powershellget/?view=powershell-5.1#powershellget) -
a package manager for Windows PowerShell.
* `MarkdownToHtml` on the [Powershell Gallery](https://www.powershellgallery.com/packages/MarkdownToHtml/2.3.1).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
