A powershell module to render markdown files.
| Branch | Status |
|---|---|
| master | |
| develop |
MarkdownPS on powershell gallery.
- New-MDCharacterStyle
- New-MDCode
- New-MDHeader
- New-MDImage
- New-MDInlineCode
- New-MDLink
- New-MDList
- New-MDParagraph
- New-MDQuote
- New-MDTable
The following Showcase script renders various artifacts as described on Github/Basic writing and formatting syntax and the output is validated on (GitHub-Flavored) Markdown Editor
# Try to render some markdown as described here
# https://help.github.com/articles/basic-writing-and-formatting-syntax/
# Verify here
# https://jbt.github.io/markdown-editor/
& "$PSScriptRoot\..\ISEScripts\Reset-Module.ps1"
$markdown=""
#region headers
$markdown+=New-MDHeader "The largest heading"
$markdown+=New-MDHeader "The second largest heading" -Level 2
$markdown+="The smallest heading"|New-MDHeader -Level 6
#endregion
#region paragraphs
$lines=@(
"Paragraphs are separated by empty lines. Within a paragraph it's possible to have a line break,"
"simply press <return> for a new line."
)
$markdown+=New-MDParagraph -Lines $lines
$lines=@(
"For example,"
"like this."
)
$markdown+=New-MDParagraph -Lines $lines
#endregion
#region CharacterStyle
$markdown+=New-MDCharacterStyle -Text "Italic characters" -Style Italic
$markdown+=New-MDParagraph
$markdown+=New-MDCharacterStyle -Text "bold characters" -Style Bold
$markdown+=New-MDParagraph
$markdown+=New-MDCharacterStyle -Text "strikethrough text" -Style StrikeThrough
$markdown+=New-MDParagraph
$markdown+="All Styles" | New-MDCharacterStyle -Style Bold| New-MDCharacterStyle -Style Italic | New-MDCharacterStyle -Style StrikeThrough
$markdown+=New-MDParagraph
#endregion
#region Lists
$markdown+=New-MDParagraph
$lines=@(
"George Washington",
"John Adams",
"Thomas Jefferson"
)
$markdown+=New-MDList -Lines $lines -Style Unordered
$lines=@(
"James Madison",
"James Monroe",
"John Quincy Adams"
)
$markdown+=New-MDList -Lines $lines -Style Ordered
$markdown+=New-MDList -Lines "Make my changes" -Style Ordered -NoNewLine
$markdown+=New-MDList -Lines @("Fix bug","Improve formatting") -Level 2 -Style Ordered -NoNewLine
$markdown+=New-MDList -Lines "Make the headings bigger" -Level 3 -Style Unordered -NoNewLine
$markdown+=New-MDList -Lines "Push my commits to GitHub" -Style Ordered -NoNewLine
$markdown+=New-MDList -Lines "Open a pull request" -Style Ordered -NoNewLine
$markdown+=New-MDList -Lines @("Describe my changes","Mention all the members of my team") -Level 2 -Style Ordered -NoNewLine
$markdown+=New-MDList -Lines "Ask for feedback" -Level 3 -Style Unordered
#endregion
#region Quote
$markdown+=New-MDParagraph -Lines "In the words of Abraham Lincoln:"
$lines=@(
"Pardon my French"
)
$markdown+=New-MDQuote -Lines $lines
$markdown+=New-MDParagraph -Lines "Multi line quote"
$lines=@(
"Line 1"
"Line 2"
)
$markdown+=New-MDQuote -Lines $lines
#endregion
#region
$markdown+="This is "+(New-MDLink -Text "an example" -Link "http://www.example.com/")+" inline link."
$markdown+=New-MDParagraph
$markdown+=(New-MDLink -Text "This link" -Link "http://www.example.com/" -Title "Title")+" has a title attribute."
$markdown+=New-MDParagraph
$markdown+=New-MDImage -Link "http://www.iana.org/_img/2013.1/iana-logo-header.svg" -AltText "Alt text"
$markdown+=New-MDParagraph
$markdown+=New-MDImage -Link "http://www.iana.org/_img/2013.1/iana-logo-header.svg" -AltText "Alt text" -Title "Optional title attribute"
$markdown+=New-MDParagraph
#endregion
#region Code quote
$markdown+="Use "+(New-MDInlineCode -Text "git status") + "to list all new or modified files that haven't yet been committed."
$markdown+=New-MDParagraph
$markdown+=New-MDParagraph -Lines "Some basic Git commands are:"
$lines=@(
"git status",
"git add",
"git commit"
)
$markdown+=New-MDCode -Lines $lines
$lines=@(
'<?xml version="1.0" encoding="UTF-8"?>'
"<node />"
)
$markdown+=New-MDCode -Lines $lines -Style "xml"
#endregion
#region Tables
$markdown+=New-MDParagraph -Lines "Without aligned columns"
$markdown+=Get-Command -Module MarkdownPS |Select-Object Name,CommandType,Version | New-MDTable
$markdown+=New-MDParagraph -Lines "With aligned columns"
$markdown+=Get-Command -Module MarkdownPS | New-MDTable -Columns ([ordered]@{Name="left";CommandType="center";Version="right"})
#endregion
$markdownParagraphs are separated by empty lines. Within a paragraph it's possible to have a line break, simply press for a new line.
For example, like this.
Italic characters
bold characters
strikethrough text
All Styles
- George Washington
- John Adams
- Thomas Jefferson
James Madison
James Monroe
John Quincy Adams
Make my changes
Fix bug
Improve formatting
- Make the headings bigger
- Push my commits to GitHub
- Open a pull request
- Describe my changes
- Mention all the members of my team
- Ask for feedback
In the words of Abraham Lincoln:
Pardon my French
Multi line quote
Line 1
Line 2
This is an example inline link.
This link has a title attribute.
Use
git statusto list all new or modified files that haven't yet been committed.Some basic Git commands are:
git status git add git commit<?xml version="1.0" encoding="UTF-8"?> <node />Without aligned columns
Name CommandType Version New-MDCharacterStyle Function 1.1 New-MDCode Function 1.1 New-MDHeader Function 1.1 New-MDImage Function 1.1 New-MDInlineCode Function 1.1 New-MDLink Function 1.1 New-MDList Function 1.1 New-MDParagraph Function 1.1 New-MDQuote Function 1.1 New-MDTable Function 1.1 With aligned columns
Name CommandType Version New-MDCharacterStyle Function 1.1 New-MDCode Function 1.1 New-MDHeader Function 1.1 New-MDImage Function 1.1 New-MDInlineCode Function 1.1 New-MDLink Function 1.1 New-MDList Function 1.1 New-MDParagraph Function 1.1 New-MDQuote Function 1.1 New-MDTable Function 1.1
