docs: PSJekyll.Site.get/set_Domain ( Fixes #61, Fixes #62 )

Adding examples
PowerShellWeb · Oct 9, 2024 · 9645417 · 9645417
1 parent 291f625
commit 9645417
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/Types/PSJekyll.Site/get_Domain.ps1 b/Types/PSJekyll.Site/get_Domain.ps1
@@ -5,6 +5,8 @@
     Gets the domain name of the Jekyll site.  
     
     This can be provided by a CNAME file in the root of the site.
+.EXAMPLE
+    $PSJekyll.CurrentSite.Domain
 #>
 $cNamePath = Join-Path $this.Directory "CNAME"
 if (Test-Path $cNamePath) {

diff --git a/Types/PSJekyll.Site/set_Domain.ps1 b/Types/PSJekyll.Site/set_Domain.ps1
@@ -5,6 +5,10 @@
     Sets the domain name of the Jekyll site.  
     
     This will create a CNAME file in the root of the site.
+
+    This will also attempt to resolve the domain name to ensure it is valid, and will write a warning if it is not.
+.EXAMPLE
+    $PSJekyll.CurrentSite.Domain = 'psjekyll.powershellweb.com'
 #>
 param([string]$cname)
 $cNamePath = Join-Path $this.Directory "CNAME"