Help/en-US/UniversalDashboard.Markdown-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDMarkdown</command:name> <command:verb>New</command:verb> <command:noun>UDMarkdown</command:noun> <maml:description> <maml:para>Markdown control for Universal Dashboard.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Display Markdown In Universal Dashboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDMarkdown</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[guid]::NewGuid()</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Markdown</maml:name> <maml:Description> <maml:para>The markdown text to render as HTML.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Styles</maml:name> <maml:Description> <maml:para>{{ Fill Styles Description }}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>@{}</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowLineNumberInCodeBlock</maml:name> <maml:Description> <maml:para>Display line number on the left of every line in code block.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RenderRawHtml</maml:name> <maml:Description> <maml:para>Render raw html that inside markdown file. Be aware that setting this to false might cause security issues if the input is user-generated. Use at your own risk.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:Description> <maml:para>{{ Fill Id Description }}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>[guid]::NewGuid()</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Markdown</maml:name> <maml:Description> <maml:para>The markdown text to render as HTML.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ShowLineNumberInCodeBlock</maml:name> <maml:Description> <maml:para>Display line number on the left of every line in code block.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Styles</maml:name> <maml:Description> <maml:para>{{ Fill Styles Description }}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>@{}</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RenderRawHtml</maml:name> <maml:Description> <maml:para>Render raw html that inside markdown file. Be aware that setting this to false might cause security issues if the input is user-generated. Use at your own risk.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>This command use react-syntax-highlighter for highlight the code block. The default theme of the highlight code is github, and it can't be change.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-UDMarkdown -Markdown '# Heading 1'</dev:code> <dev:remarks> <maml:para>Create <h1> tag with text Heading 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>New-UDPage -Name Home -Icon code -Content {</dev:code> <dev:remarks> <maml:para>New-UDRow -Columns { New-UDColumn -Content { # Get the content of markdown file. $md = Get-Content -Path .\PowerShell\DemoPage.md New-UDMarkdown -Markdown $md -CodeBlockStyle @{ 'border-radius' = '6px' background = '#e6e6e6' padding = '16px' } -CodeBlockShowLineNumbers } } }</maml:para> <maml:para>Render the content of DemoPage.md, Add custom style to the code block and display line numbers in code block.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |