From 5a0813495a0edbaea395cb3a709f2185b6be90df Mon Sep 17 00:00:00 2001 From: Paul Hibbitts Date: Tue, 13 Aug 2024 14:26:39 -0700 Subject: [PATCH 1/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f110381c..73f286f3 100644 --- a/README.md +++ b/README.md @@ -528,7 +528,7 @@ The following style prefixes are available with Docsify-This: * [image-border](#image-border) * [image-border-rounded](#image-border-rounded) * [navpill](#navpill) -* [responsive](/#responsive) +* [responsive](#responsive) * [row/column](#rowcolumn) * [video-container-4by3](#video-container-4by3) * [video-container-16by9](#video-container-16by9) From b5c6ae2e562092e455d272c446b51e1b2abbd75b Mon Sep 17 00:00:00 2001 From: Paul Hibbitts Date: Tue, 13 Aug 2024 14:31:10 -0700 Subject: [PATCH 2/7] Update Search docs. --- README.md | 8 ++++---- docs/README.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 73f286f3..75b05547 100644 --- a/README.md +++ b/README.md @@ -381,7 +381,7 @@ The following additional URL parameters are also available for use in Docsify-Th * [name](#name) * [page-title](#page-title) * [pagination](#pagination) -* [search](#search) +* [searchbox](#searchbox) * [submaxLevel](#subMaxLevel) ##### coverpage @@ -440,9 +440,9 @@ https://docsify-this.net?basePath=https://raw.githubusercontent.com/paulhibbitts Display Pagination buttons in page content area (Docsify custom Sidebar required) with the optional **pagination** parameter, for example: https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&search=true&pagination=true -##### search -Enable the Docsify Search plugin (which currently includes matches for text and markup) on multiple page sites including a custom Sidebar with the optional **search** Docsify parameter, for example: -https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&search=true +##### searchbox +Enable the Docsify Search plugin (which currently includes matches for text and markup) on multiple page sites including a custom Sidebar with the optional **searchbox** Docsify parameter, for example: +https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&searchbox=true ##### subMaxLevel 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: diff --git a/docs/README.md b/docs/README.md index 140dee8f..80ab7063 100644 --- a/docs/README.md +++ b/docs/README.md @@ -650,7 +650,7 @@ The following additional URL parameters are also available for use in Docsify-Th * [name](/?id=name) * [page-title](/?id=page-title) * [pagination](/?id=pagination) -* [search](/?id=subMaxLevel) +* [searchbox](/?id=searchbox) * [subMaxLevel](/?id=subMaxLevel) ##### coverpage @@ -709,9 +709,9 @@ https://docsify-this.net?basePath=https://raw.githubusercontent.com/paulhibbitts Display Pagination buttons in page content area (Docsify custom Sidebar required) with the optional **pagination** parameter, for example: https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&search=true&pagination=true -##### search -Enable the Docsify Search plugin (which currently includes matches for text and markup) on multiple page sites including a custom Sidebar with the optional **search** Docsify parameter, for example: -https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&search=true +##### searchbox +Enable the Docsify Search plugin (which currently includes matches for text and markup) on multiple page sites including a custom Sidebar with the optional **searchbox** Docsify parameter, for example: +https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&searchbox=true ##### subMaxLevel 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: From f689bcc9e2b15a5c1e8aa2cf788c0100cb3b87b0 Mon Sep 17 00:00:00 2001 From: Paul Hibbitts Date: Tue, 13 Aug 2024 14:35:35 -0700 Subject: [PATCH 3/7] Update README.md --- docs/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 80ab7063..d7ee7555 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1389,6 +1389,8 @@ Docsify-This is intended as a quick way to display one or more remotely located You can also have an instance of Docsify-This run on [Codeberg](https://codeberg.org/) such as https://docsify-this.codeberg.page by creating a new repository called `pages`, then choosing **paulhibbitts/docsify-this-app** in the **template** dropdown menu, choosing the **Git Content (Default Branch)** option and then tapping the **Create Repository** button. +Alternatively, you can upload the files in the Docsify-This `/docs` folder into a newly created Codeberg repository and then manually enable [Codeberg Pages](https://docs.codeberg.org/codeberg-pages/). An example Docsify-This instance running on Codeberg is available at https://codeberg.org/paulhibbitts/docsify-this-app, which uses a Branch renamed to `pages`. + If you want to run Docsify-This on your own Websever, create a destination folder on your server and then copy the files within the Docsify-This folder `/docs` to your newly created server folder. A more future-friendly setup would be to fork the Docsify-This repository (to support getting upstream updates) and use a GitHub Action such as [FTP-Deploy](https://github.com/SamKirkland/FTP-Deploy-Action) to deploy all repository files to a Webserver and set the `docs` folder as a custom domain root. You can limit the domains which remote files can be rendered from by locating the line `var allowedDomains = '';` within the `index.html` file and include your list of allowed domains separated by commas, for example `var allowedDomains = 'codeberg.org,raw.githubusercontent.com,hibbittsdesign.org';`. @@ -1440,7 +1442,7 @@ Due to iframe cross-domain issues embedded content may not be able to be display For example, the following iFrame HTML: ```html -
+ ``` Would be changed to: From 18b1f717616697c3799e8303609efb664efee1b4 Mon Sep 17 00:00:00 2001 From: Paul Hibbitts Date: Tue, 13 Aug 2024 14:35:37 -0700 Subject: [PATCH 4/7] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 75b05547..a3acd1d6 100644 --- a/README.md +++ b/README.md @@ -1061,7 +1061,7 @@ Due to iframe cross-domain issues embedded content may not be able to be display For example, the following iFrame HTML: ```html -
+ ``` Would be changed to: From 85114af8da264af3bf025572f98bc08b16023454 Mon Sep 17 00:00:00 2001 From: Paul Hibbitts Date: Tue, 13 Aug 2024 14:41:00 -0700 Subject: [PATCH 5/7] Update README.md --- docs/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/README.md b/docs/README.md index d7ee7555..2e2f698f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -646,6 +646,7 @@ The following additional URL parameters are also available for use in Docsify-Th * [loadFooter](/?id=loadFooter) * [loadNavbar](/?id=loadNavbar) * [loadSidebar](/?id=loadSidebar) +* [mergeNavbar](/?id=mergeNavbar) * [logo](/?id=logo) * [name](/?id=name) * [page-title](/?id=page-title) @@ -697,6 +698,10 @@ https://docsify-this.net/?basePath=https://raw.githubusercontent.com/paulhibbitt Display a logo image for the Website in a Docsify custom Sidebar (i.e. file 'logo.png) with the optional **logo** Docsify parameter, for example: https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&name=CPT-363&logo=/images/logo.png The full folder path and filename must be provided. When a Website name is provided it will be used as the alt text for the logo. +##### mergeNavbar +Merge the Navbar items to the top of the sidebar on smaller screens with the optional **mergeNavbar** Docsify parameter, for example: +https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&mergeNavbar=true&name=CPT-363 + ##### name Display the name of the Website in a Docsify custom Sidebar (i.e. file '_sidebar.md) with the optional **name** Docsify parameter, for example: https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&search=true&name=CPT-363 When this parameter is provided it will be automatically used as the Browser tab title as well. From 241cadba0487f5f141eaecd1565c44801a9eac2b Mon Sep 17 00:00:00 2001 From: Paul Hibbitts Date: Tue, 13 Aug 2024 14:41:03 -0700 Subject: [PATCH 6/7] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a3acd1d6..6aec6c51 100644 --- a/README.md +++ b/README.md @@ -365,7 +365,7 @@ https://docsify-this.net?basePath=https://raw.githubusercontent.com/paulhibbitts #### Additional URL Parameters (included in the Advanced Web Page Builder) -The following additional URL parameters are also available for use in Docsify-This URLs, and are included in the [Advanced Web Page Builder](ttps://docsify-this.net?advanced=true) unless otherwise indicated. +The following additional URL parameters are also available for use in Docsify-This URLs, and are included in the [Advanced Web Page Builder](https://docsify-this.net?advanced=true) unless otherwise indicated. * [coverpage](#coverpage) * [coverpage-color](#coverpage-color) @@ -378,6 +378,7 @@ The following additional URL parameters are also available for use in Docsify-Th * [loadNavbar](#loadNavbar) * [loadSidebar](#loadSidebar) * [logo](#logo) +* [mergeNavbar](#mergeNavbar) * [name](#name) * [page-title](#page-title) * [pagination](#pagination) @@ -428,6 +429,10 @@ https://docsify-this.net/?basePath=https://raw.githubusercontent.com/paulhibbitt Display a logo image for the Website in a Docsify custom Sidebar (i.e. file 'logo.png) with the optional **logo** Docsify parameter, for example: https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&name=CPT-363&logo=/images/logo.png The full folder path and filename must be provided. When a Website name is provided it will be used as the alt text for the logo. +##### mergeNavbar +Merge the Navbar items to the top of the sidebar on smaller screens with the optional **mergeNavbar** Docsify parameter, for example: +https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&mergeNavbar=true&name=CPT-363 + ##### name Display the name for the Website in a Docsify custom Sidebar (i.e. file '_sidebar.md) with the optional **name** Docsify parameter, for example: https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course-site/main&homepage=home.md&sidebar=true&loadSidebar=_sidebar.md&loadNavbar=_navbar.md&search=true&name=CPT-363 When this parameter is provided it will be automatically used as the Browser tab title as well. From 2f92eb2e959e0bcb9c9e97430c868dc38e6406f6 Mon Sep 17 00:00:00 2001 From: Paul Hibbitts Date: Tue, 13 Aug 2024 14:41:05 -0700 Subject: [PATCH 7/7] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 73067250..47ac44b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ **Improved:** * Support for mathmatical formula display now provided by the Latex plugin for compatibility with future Marked.js compatibility (with thanks and appreciation to @scruel) * Support of the alias searchbox for search for future Docsify-This compatibility, including using the searchbox parameter in the Advanced Web Page Builder +* Updated ReadMe ## [1.9.8] - 07/23/2024