Merge pull request #160 from hibbitts-design/docsify-this-v1

Docsify this v1
hibbitts-design · Nov 20, 2024 · b046176 · b046176
2 parents 260d066 + 3d1a049
commit b046176
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## [1.9.16] - XX/XX/2024
 
+**Improved:**
+* Updated ReadMe
+
 **Bugfix:**
 * More robust handling of of Web Page Builder custom settings
 

diff --git a/README.md b/README.md
@@ -301,6 +301,7 @@ The following additional URL parameters are available for use in Docsify-This UR
 * [pagination](#pagination)
 * [searchbox](#searchbox)
 * [submaxLevel](#subMaxLevel)
+* [svg-icons](#svg-icons)
 
 ##### coverpage
 Display a [Docsify custom coverpage](https://docsify.js.org/#/configuration?id=coverpage) with the optional **coverpage** parameter, for example:  
@@ -374,6 +375,10 @@ https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-des
 Set the maximum automatic table of contents header levels in Docsify custom Sidebar (i.e. file '_sidebar.md) with the optional **subMaxLevel** Docsify parameter, for example:  
 https://docsify-this.net/?basePath=https://raw.githubusercontent.com/paulhibbitts/docsify-this-cmpt-363-222-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar-with-home.md&subMaxLevel=1
 
+##### svg-icons
+Use the SVG version of Font Awesome icons instead of Web Fonts with the optional **svg-icons** parameter (not included in the Advanced Web Page Builder), for example:  
+https://v2.preview.docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-lms-content-pages/main&homepage=schedule.md&svg-icons=true
+
 ---
 
 #### Embedding Docsify-This Pages into Other Platforms

diff --git a/docs/README.md b/docs/README.md
@@ -474,6 +474,7 @@ The following additional URL parameters are available for use in Docsify-This UR
 * [pagination](/?id=pagination)
 * [searchbox](/?id=searchbox)
 * [subMaxLevel](/?id=subMaxLevel)
+* [svg-icons](/?id=svg-icons)
 
 ##### coverpage
 Display a [Docsify custom coverpage](https://docsify.js.org/#/configuration?id=coverpage) with the optional **coverpage** parameter, for example:  
@@ -547,6 +548,10 @@ https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-des
 Set the maximum automatic table of contents header levels in Docsify custom Sidebar (i.e. file '_sidebar.md) with the optional **subMaxLevel** Docsify parameter, for example:  
 https://docsify-this.net/?basePath=https://raw.githubusercontent.com/paulhibbitts/docsify-this-cmpt-363-222-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar-with-home.md&subMaxLevel=1
 
+##### svg-icons
+Use the SVG version of Font Awesome icons instead of Web Fonts with the optional **svg-icons** parameter (not included in the Advanced Web Page Builder), for example:  
+https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-lms-content-pages/main&homepage=schedule.md&svg-icons=true
+
 ---
 
 #### Embedding Docsify-This Pages into Other Platforms

diff --git a/docs/index.html b/docs/index.html
@@ -1264,6 +1264,7 @@
               return; // Exit if basePath is present
             }
 
+            // Check for valid URL parms or a URL-like pattern after a '?' by using RegEx
             if (getURLParameterByName(['url-field', 'urlField']) || (window.location.href.includes('?') && /[?&](url-field|urlField|https?:\/\/[^\s]+|www\.[^\s]+|[a-z0-9.-]+\.[a-z]{2,})/i.test(window.location.href))) {
               var markdownFileURL = '';