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

Adding examples
PowerShellWeb · Oct 9, 2024 · 96261a4 · 96261a4
1 parent 9645417
commit 96261a4
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/PSJekyll.types.ps1xml b/PSJekyll.types.ps1xml
@@ -813,6 +813,8 @@ foreach ($arg in $unrolledArguments) {
     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
 #&gt;
 $cNamePath = Join-Path $this.Directory "CNAME"
 if (Test-Path $cNamePath) {
@@ -827,6 +829,10 @@ if (Test-Path $cNamePath) {
     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'
 #&gt;
 param([string]$cname)
 $cNamePath = Join-Path $this.Directory "CNAME"