docs: MarkX Types Documentation

Author: James Brundage

Types/MarkX/MarkX.format.ps1

@@ -1 +1,7 @@
+<#
+.SYNOPSIS
+    MarkX Formatting
+.DESCRIPTION
+    MarkX formatting source
+#>
 Write-FormatView -TypeName MarkX -Property Markdown -Wrap

Types/MarkX/get_Images.ps1

@@ -1,3 +1,11 @@
+<#
+.SYNOPSIS
+    Gets Markdown Images
+.DESCRIPTION
+    Gets `<img>` tags found within Markdown after it has been converted to XML
+.NOTES
+    If the Markdown could not be converted to XML, this will return nothing.
+#>
 foreach ($aNode in $this.XML | Select-Xml //img) {
     if ($aNode.Node.src) {
         $aNode.Node

Types/MarkX/get_Input.ps1

@@ -1 +1,7 @@
+<#
+.SYNOPSIS
+    Gets MarkX input
+.DESCRIPTION
+    Gets the input objects for a MarkX object.
+#>
 return $this.'#input'

Types/MarkX/get_Link.ps1

@@ -1,3 +1,15 @@
+<#
+.SYNOPSIS
+    Gets Markdown Links
+.DESCRIPTION
+    Gets anchor links from within Markdown content.
+.NOTES
+    This will return the links nodes after the Markdown is converted to XML.
+    
+    If XML conversion fails, this will not return any values.
+
+    To find hyperlinks within Markdown, use `.FindHyperlink()`
+#>
 foreach ($aNode in $this.XML | Select-Xml //a) {
     if ($aNode.Node.href) {
         $aNode.Node

Types/MarkX/get_Markdown.ps1

@@ -1 +1,9 @@
+<#
+.SYNOPSIS
+    Gets Markdown
+.DESCRIPTION
+    Gets the cached Markdown value for any MarkX object.
+
+    This should be a markdown representation of the object.
+#>
 return $this.'#Markdown'

Types/MarkX/set_Input.ps1

@@ -1,7 +1,19 @@
+<#
+.SYNOPSIS
+    Sets MarkX Input
+.DESCRIPTION
+    Sets the input for a MarkX file or site.
+
+    This will attempt to convert the input to Markdown, 
+    and then will `.Sync()` the object.
+#>
 param(
+# One or more input objects
 [PSObject[]]$InputObject
 )
 
+# Set the `#Input` property
 $this | Add-Member NoteProperty '#Input' $InputObject -Force
 
+# and then Sync.
 $this.Sync()

Types/MarkX/set_Markdown.ps1

@@ -1,4 +1,13 @@
+<#
+.SYNOPSIS
+    Sets Markdown
+.DESCRIPTION
+    Sets the Markdown on an object.
+.NOTES
+    This will change the `.Input` property, which will then `.Sync()` the markdown.
+#>
 param(
+# Any new or updated markdown content.
 [PSObject[]]$Markdown
 )