Update theme (#656)

* Update Theme

switch to hugo-book-9 theme for auto light/dark mode

update hugo to 68.3 for compatibility with hugo-book-9

use details-shortcut instead of expand-shortcode for compatibility

* update --theme calls in the CI/CD workflows

* httrack didn't work with newer repo; start dumping directory listings, etc

* hugo static (dir 2)

* hugo static: -d (dir 3)

* hugo static: -d with artifact (dir 4)

* hugo static: starting to filter

* these static-hugo commands properly cleaned the static_html during my local tests, so hopefully will work as an action as well

* update both CI_build and onRelease to match

* tweak the naming in the CI_build

* add variant of pbarney's color/horizontal-line for headers

closes #653

* tweak h2 color for dark mode

Author: pryrt

.github/workflows/CD_publish.yml

@@ -22,16 +22,16 @@ jobs:
     - name: 🚚 Checkout repo
       uses: actions/checkout@v4
 
-    - name: 📡 Get Hugo-Extended v0.57.2
+    - name: 📡 Get Hugo-Extended v0.68.3
       #uses: peaceiris/actions-hugo@v2  # @v2 and @v2.6.0 giving node16-vs-node20 error in GitHub Actions
       uses: ricomariani/actions-hugo@16ab92f9dbb1f28bb75268a4a5eede16cdc2a6e2
       with:
-        hugo-version: '0.57.2'
+        hugo-version: '0.68.3'
         extended: true
 
     - name: 🔨 Build into ./public
       working-directory: .
-      run: hugo --theme book
+      run: hugo --theme hugo-book-9
 
     - name: 🎉 Deploy to npp-user-manual.org
       uses: wlixcc/[email protected]

.github/workflows/CI_build.yml

@@ -11,36 +11,67 @@ jobs:
     - name: 🚚 Checkout repo
       uses: actions/checkout@v4
 
-    - name: 📡 Install hugo extended and httrack via chocolatey
+    - name: 📡 Install hugo-extended via chocolatey
       working-directory: .
       run: |
-           choco install hugo-extended --version 0.57.2
-           choco install httrack
+           choco install hugo-extended --version 0.68.3
 
     - name: 🔨 Build static HTML for site
       working-directory: .
       run: |
-           cmd /c start hugo.exe server --theme book
-           $env:Path += ";C:\Program Files\WinHTTrack\"
-           httrack.exe "http://127.0.0.1:1313/" -O "./httrack_output"
-           Set-Location -Path httrack_output
-           Rename-Item -Path 127.0.0.1_1313 -NewName nppUserManual
-           Get-ChildItem -Recurse "./nppUserManual" -Filter index.html | Foreach-Object {
+           hugo.exe -d static_html --theme hugo-book-9 --baseURL "http://localhost:1313"
+
+            # first do the changes that go in all the HTML files
+            Get-ChildItem -Recurse "./static_html" -Filter index.html | Foreach-Object {
                $orgname = $_.FullName
                $tmpname = "$($orgname).unedited"
-               echo $tmpname
                Copy-Item $orgname $tmpname
                get-content $tmpname |
-                    %{$_ -replace 'id="book-search-input" maxlength="64" readonly','id="book-search-input" maxlength="64" readonly hidden'} |
-                    %{$_ -replace 'href="http://localhost:1313/"','href="./index.html"'} |
-                    %{$_ -replace 'href="http://localhost:1313/','href="'} |
+                    %{$_ -replace 'id="book-search-input"','id="book-search-input" readonly hidden'} |
+                    %{$_ -replace 'integrity="','attr_integ_ignore="'} |
                     set-content $orgname
                Remove-Item $tmpname
-           }
+            }
+
+            # need different replacements at different depths
+            Copy-Item "./static_html/index.html" "./static_html/index.html.source"
+            get-content "./static_html/index.html.source" |
+                    %{$_ -replace '(href|content|src)="/','$1="./'} |
+                    %{$_ -replace '(href|content|src)="http://localhost:1313/','$1="./'} |
+                    %{$_ -replace '((?:href|content|src)="\./[^"]*?)/"','$1/index.html"'} |
+                    set-content "./static_html/index.html"
+            Remove-Item "./static_html/index.html.source"
+
+            # need to delay the docs-level index, but save the existing copy, so that I can easily recurse
+            #   to the deep directories, and then do the docs-level
+            Copy-Item "./static_html/docs/index.html" "./static_html/docs/index.html.source"
+
+            # recurse to the deepest level
+            Get-ChildItem -Recurse "./static_html/docs" -Filter index.html | Foreach-Object {
+               $orgname = $_.FullName
+               $tmpname = "$($orgname).unedited"
+               Copy-Item $orgname $tmpname
+               get-content $tmpname |
+                    %{$_ -replace '(href|content|src)="/','$1="../../'} |
+                    %{$_ -replace '(href|content|src)="http://localhost:1313/','$1="../../'} |
+                    %{$_ -replace '((?:href|content|src)="\.[^"]*?)/"','$1/index.html"'} |
+                    set-content $orgname
+               Remove-Item $tmpname
+            }
+
+            # now do the docs-level
+            get-content "./static_html/docs/index.html.source" |
+                    %{$_ -replace '(href|content|src)="/','$1="../'} |
+                    %{$_ -replace '(href|content|src)="http://localhost:1313/','$1="../'} |
+                    %{$_ -replace '((?:href|content|src)="\.[^"]*?)/"','$1/index.html"'} |
+                    set-content "./static_html/docs/index.html"
+            Remove-Item "./static_html/docs/index.html.source"
+
+            # rename before artifact
+            Rename-Item -Path static_html -NewName nppUserManual
 
     - name: 🎉 Store zipfile as artifact
       uses: actions/upload-artifact@v4
       with:
           name: nppUserManual
-          path: ./httrack_output/nppUserManual/
-
+          path: ./nppUserManual/

.github/workflows/onRelease_zip_manual_as_asset.yml

@@ -17,40 +17,71 @@ jobs:
     - name: 🚚 Checkout repo
       uses: actions/checkout@v4
 
-    - name: 📡 Install hugo-extended and httrack via chocolatey
+    - name: 📡 Install hugo-extended via chocolatey
       working-directory: .
       run: |
-           choco install hugo-extended --version 0.57.2
-           choco install httrack
+            choco install hugo-extended --version 0.68.3
 
     - name: 🔨 Build static HTML for site
       working-directory: .
       run: |
-           cmd /c start hugo.exe server --theme book
-           $env:Path += ";C:\Program Files\WinHTTrack\"
-           httrack.exe "http://127.0.0.1:1313/" -O "./httrack_output"
-           Set-Location -Path httrack_output
-           Rename-Item -Path 127.0.0.1_1313 -NewName nppUserManual
-           Get-ChildItem -Recurse "./nppUserManual" -Filter index.html | Foreach-Object {
+            hugo.exe -d static_html --theme hugo-book-9 --baseURL "http://localhost:1313"
+
+            # first do the changes that go in all the HTML files
+            Get-ChildItem -Recurse "./static_html" -Filter index.html | Foreach-Object {
+               $orgname = $_.FullName
+               $tmpname = "$($orgname).unedited"
+               Copy-Item $orgname $tmpname
+               get-content $tmpname |
+                    %{$_ -replace 'id="book-search-input"','id="book-search-input" readonly hidden'} |
+                    %{$_ -replace 'integrity="','attr_integ_ignore="'} |
+                    set-content $orgname
+               Remove-Item $tmpname
+            }
+
+            # need different replacements at different depths
+            Copy-Item "./static_html/index.html" "./static_html/index.html.source"
+            get-content "./static_html/index.html.source" |
+                    %{$_ -replace '(href|content|src)="/','$1="./'} |
+                    %{$_ -replace '(href|content|src)="http://localhost:1313/','$1="./'} |
+                    %{$_ -replace '((?:href|content|src)="\./[^"]*?)/"','$1/index.html"'} |
+                    set-content "./static_html/index.html"
+            Remove-Item "./static_html/index.html.source"
+
+            # need to delay the docs-level index, but save the existing copy, so that I can easily recurse
+            #   to the deep directories, and then do the docs-level
+            Copy-Item "./static_html/docs/index.html" "./static_html/docs/index.html.source"
+
+            # recurse to the deepest level
+            Get-ChildItem -Recurse "./static_html/docs" -Filter index.html | Foreach-Object {
                $orgname = $_.FullName
                $tmpname = "$($orgname).unedited"
-               echo $tmpname
                Copy-Item $orgname $tmpname
                get-content $tmpname |
-                    %{$_ -replace 'id="book-search-input" maxlength="64" readonly','id="book-search-input" maxlength="64" readonly hidden'} |
-                    %{$_ -replace 'href="http://localhost:1313/"','href="./index.html"'} |
-                    %{$_ -replace 'href="http://localhost:1313/','href="'} |
+                    %{$_ -replace '(href|content|src)="/','$1="../../'} |
+                    %{$_ -replace '(href|content|src)="http://localhost:1313/','$1="../../'} |
+                    %{$_ -replace '((?:href|content|src)="\.[^"]*?)/"','$1/index.html"'} |
                     set-content $orgname
                Remove-Item $tmpname
-           }
-           Compress-Archive -Path nppUserManual -DestinationPath nppUserManual.zip
-           Set-Location -Path ..
+            }
+
+            # now do the docs-level
+            get-content "./static_html/docs/index.html.source" |
+                    %{$_ -replace '(href|content|src)="/','$1="../'} |
+                    %{$_ -replace '(href|content|src)="http://localhost:1313/','$1="../'} |
+                    %{$_ -replace '((?:href|content|src)="\.[^"]*?)/"','$1/index.html"'} |
+                    set-content "./static_html/docs/index.html"
+            Remove-Item "./static_html/docs/index.html.source"
+
+            # now zip it
+            Rename-Item -Path static_html -NewName nppUserManual
+            Compress-Archive -Path nppUserManual -DestinationPath nppUserManual.zip
 
     - name: 🎉 Store zipfile as asset
       uses: svenstaro/upload-release-action@v2
       with:
         repo_token: ${{ secrets.GITHUB_TOKEN }}
-        file: ./httrack_output/nppUserManual.zip
+        file: ./nppUserManual.zip
         asset_name: nppUserManual.zip
         tag: ${{ github.ref }}
         overwrite: true

README.md

@@ -38,7 +38,7 @@ How to test site locally
 =======
 
 **Notepad++ User Manual** website is generated by [Hugo](https://gohugo.io/) by using [hugo-book theme](https://github.com/alex-shpak/hugo-book).
-In order to visualize the site (with your modification) on your computer locally, you have to download [Hugo **extended** version](https://github.com/gohugoio/hugo/releases) firstly.
+In order to visualize the site (with your modification) on your computer locally, you have to download [Hugo **extended** version](https://github.com/gohugoio/hugo/releases) firstly (v68.3 is currently recommended for compatibility purposes).
 Go to the root of Notepad++ User Manual repository under your bash shell (use `Git bash` under windows) then type `HUGODIR\hugo.exe server --minify --theme book`
 
 ```txt

config.toml

@@ -2,4 +2,16 @@ baseURL = "https://npp-user-manual.org/"
 languageCode = "en-us"
 title = "Notepad++ User Manual"
 
-theme = "book"
+theme = "hugo-book-9"
+
+[params]
+  # (Optional, default light) Sets color theme: light, dark or auto.
+  # Theme 'auto' switches between dark and light modes based on browser/os preferences
+  BookTheme = 'auto'
+
+[markup.goldmark.renderer]
+unsafe= true
+
+[markup.tableOfContents]
+startLevel = 1
+endLevel = 6

content/_index.md

@@ -6,7 +6,7 @@ type: docs
 Notepad++ User Manual
 =======
 
-This **Notepad++ User Manual** describes the Notepad++ application v8.x (currently up to v8.6.4).
+This **Notepad++ User Manual** describes the Notepad++ application v8.x (currently up to v8.6.5).
 
 The documentation is built collaboratively, and [your contribution is very welcome](https://github.com/notepad-plus-plus/npp-usermanual), following our [contribution guidelines](https://github.com/notepad-plus-plus/npp-usermanual/blob/master/CONTRIBUTION.md).
 

content/docs/binary-translation.md

@@ -3,7 +3,7 @@ title: Localization - User Interface Translation
 weight: 170
 ---
 
-Notepad++ can be "localized" to your chosen written language, so that it translates the user interface (including menu and command names, and the text in dialogs and buttons).  It supports this multi-language functionality by using a localization xml file (based on the official [english.xml](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/installer/nativeLang/english.xml) translation) which maps the various user-interface pieces to the appropriate translation.  The Notepad++ localization is chosen through the **[Settings > Preferences > General](../preferences/#general)] > Localization** interface.
+Notepad++ can be "localized" to your chosen written language, so that it translates the user interface (including menu and command names, and the text in dialogs and buttons).  It supports this multi-language functionality by using a localization xml file (based on the official [english.xml](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/installer/nativeLang/english.xml) translation) which maps the various user-interface pieces to the appropriate translation.  The Notepad++ localization is chosen through the **[Settings > Preferences > General](../preferences/#general) > Localization** interface.
 
 ### Creating or Editing a translation
 

content/docs/command-prompt.md

@@ -43,7 +43,7 @@ notepad++ [--help] [-multiInst] [-noPlugin]
   should match an existing UDL.  Mutually exclusive with `-l` (UDL will take priority
   over standard syntax highlighter).  (new to v8.1.2)
 * `-L`: Apply indicated localization, *langCode* maps to the localization file name:
-    {{< expand "show Language Codes" >}}
+    {{< details "show Language Codes" >}}
 code | file
 ---|---
 `ab`, `abk` | `abkhazian.xml`
@@ -137,7 +137,7 @@ code | file
 `zh-tw`, `zh-hk`, `zh-sg` | `taiwaneseMandarin.xml`
 `zh`, `zh-cn` | `chineseSimplified.xml`
 `zu`, `zu-za` | `zulu.xml`
-    {{< /expand >}}
+    {{< /details >}}
 * `-n`: Scroll to indicated line (*LineNumber*) on `filepath`.
 * `-c`: Scroll to indicated column (*ColumnNumber*) on `filepath`.
 * `-p`: Scroll to indicated 0 base position (*Position*) on `filepath`.

content/docs/plugin-communication.md

@@ -28,11 +28,11 @@ In cases when either wParam, lParam or both are not used, they must be set to 0.
 
 The message IDs for each of these named messages, as well as the enums used with these messages, can be found in the source code in [Notepad_plus_msgs.h](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/PowerEditor/src/MISC/PluginsManager/Notepad_plus_msgs.h).
 
-{{< expand "Aside: interpreting #defines" >}}
+{{< details "Aside: interpreting #defines" >}}
 If you are writing your plugin in C++ or similar languages, you should just include the `Notepad_plus_msgs.h` to get all the constants; but if you are using a different language for your plugin or other message-interface, you will need to translate those `#define` statements to constants or values appropriate to your language.
 
 When reading the `#define` for the various `NPPM_` constants, you need to notice that `NPPMSG` is defined as `(WM_USER + 1000)` near the top of the file, and you need to know that [`WM_USER`](https://learn.microsoft.com/en-us/windows/win32/winmsg/wm-user) is the Windows standard constant with a value of `0x0400` (1024).  You may need to look up other `#define` values from elsewhere in the header file in order to fully resolve some of the values.  For example, `#define NPPM_SAVEALLFILES (NPPMSG + 39)` is really the integer 1024 + 1000 + 39 = 2063, so that is the value you need to use when defining your version of the `NPPM_SAVEALLFILES` constant.
-{{< /expand >}}
+{{< /details >}}
 
 You can also communicate to the Scintilla editor instances inside Notepad++ by using the Scintilla messages, which are [documented at the Scintilla website](https://www.scintilla.org/ScintillaDoc.html), and the values can be found in [Scintilla.h](https://github.com/notepad-plus-plus/notepad-plus-plus/blob/master/scintilla/include/Scintilla.h). Note, you need to use one of the two Scintilla handles as the first parameter to SendMessage api function.
 

content/docs/views.md

@@ -33,7 +33,7 @@ There are four entries that are grouped together, which can affect the rendering
 
 - **Show Non-Printing Characters**: When checked, the characters below will be shown in a small box, either as the Codepoint or as the Abbreviation, depending on [Settings > Preferences > Editing > Non-Printing Characters](../preferences/#editing-1).  The boxed characters are colored as "reverse text", and can be customized through [Global Styles > Default > NPC Custom color](../preferences/#global-styles "see Style Configurator > Global Styles") settings if the [Editing > Non-Printing Characters > Custom Color](../preferences/#editing-1) is checked.  (New to v8.5)
 
-    {{< expand "Table of Non-Printing Characters" >}}
+    {{< details "Table of Non-Printing Characters" >}}
 Codepoint | Character Name               | Abbreviation
 ----------|------------------------------|---------------
 U+0085    | next line                    | NEL
@@ -79,7 +79,7 @@ U+206E    | national digit shapes        | NADS
 U+206F    | nominal digit shapes         | NODS
 U+3000    | ideographic space            | IDSP
 U+FEFF    | zero-width no-break space    | ZWNBSP
-    {{< /expand >}}
+    {{< /details >}}
 
 - **Show Control Characters & Unicode EOL**: When checked, the control characters in the ASCII/Unicode [C0 and C1 control codes](https://en.wikipedia.org/wiki/C0_and_C1_control_codes) will be shown in a small box, either as the Codepoint or as an Abbreviation.  In addition to the C0 and C1 control codes, this also influences the Unicode "End of Line" characters LINE SEPARATOR (U+2028: `LS`) and PARAGRAPH SEPARATOR (U+2029: `PS`).  (new to v8.5.3)