improved mkdocs output

Author: fracpete

.github/workflows/main.yaml

@@ -14,17 +14,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Master
-        uses: actions/checkout@v2
+        uses: actions/checkout@v6
 
       - name: Set up Python 3.9
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v6
         with:
-          python-version: '3.9'
+          python-version: '3.12'
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install mkdocs==1.4.2 jinja2==3.1.2 "Markdown<3.4.0" mkdocs-material==8.5.10
+          pip install mkdocs==1.6.1 jinja2==3.1.6 Markdown==3.10.2 MarkupSafe==3.0.3 mkdocs-material==9.7.6 mkdocs-material-extensions==1.3.1 Pygments==2.20.0 pymdown-extensions==10.21.2 click==8.2.1
 
       - name: Deploy
         run: |

RELEASE.md

@@ -25,15 +25,15 @@ How to make a release
   * if necessary, install mkdocs in a virtual environment
 
     * `virtualenv -p /usr/bin/python3 venv`
-    * `./venv/bin/pip install mkdocs==1.4.2 jinja2==3.1.2 "Markdown<3.4.0" mkdocs-material==8.5.10`
+    * `./venv/bin/pip install mkdocs==1.6.1 jinja2==3.1.6 Markdown==3.10.2 MarkupSafe==3.0.3 mkdocs-material==9.7.6 mkdocs-material-extensions==1.3.1 Pygments==2.20.0 pymdown-extensions==10.21.2 click==8.2.1`
 
   * add new release link (`releases.md`)
   * update artifact version (`maven.md`)
   * update OpenSSH versions (`windows.md`)
   * test 
 
     ```
-    ./venv/bin/mkdocsmkdocs build --clean && ./venv/bin/mkdocsmkdocs serve
+    ./venv/bin/mkdocs build --clean && ./venv/bin/mkdocs serve
     ```
     
   * deployment happens automatically on commit

docs/env_vars.md

@@ -1,4 +1,4 @@
-# Linux/Mac {: #linux_mac }
+# Linux/Mac
 
 Starting with release 3.2.3-12, the locations of the underlying binaries can be 
 changed via the following environment variables:
@@ -9,7 +9,7 @@ changed via the following environment variables:
 * `RSYNC4J_SSHKEYGEN`
 
 
-# Windows {: #windows }
+# Windows
 
 It is possible to use another location than `%USERPROFILE%\rsync4j`. You only
 have to configure the `RSYNC4J_HOME` environment variable to point to the top-level

docs/index.md

@@ -3,7 +3,7 @@ for Linux, Mac OSX and Windows.
 
 For Windows, binaries are included in the jars and *rsync4j* 
 will set up an environment in the user's home directory (`%USERPROFILE%\rsync4j`)
-on first usage (can be customized, see Section [Environment variables/Windows](env_vars/#windows)). 
+on first usage (can be customized, see Section [Environment variables/Windows](env_vars.md#windows)). 
 
 In November 2022, the 32-bit version of Cygwin reached its end-of-life.
-Therefore 32-bit support is only available up to version: 3.2.3-12 
+Therefore, 32-bit support is only available up to version: 3.2.3-12 

docs/windows.md

@@ -77,5 +77,5 @@ to remotehost `otherbox` into directory `C:\other\dir` using these paths:
 
 ### Custom location {: #custom-location }
 
-See [Environment variables/Windows](/env_vars/#windows).
+See [Environment variables/Windows](env_vars.md#windows).
 

mkdocs.yml

@@ -4,11 +4,21 @@ edit_uri: edit/master/docs/
 site_description: rsync4j Documentation
 theme:
     name: material
+    features:
+      - content.code.copy
 markdown_extensions:
     - toc:
           baselevel: 2
           permalink: "#"
     - attr_list
+    - sane_lists
+    - pymdownx.highlight:
+        anchor_linenums: true
+        line_spans: __span
+        pygments_lang_class: true
+    - pymdownx.inlinehilite
+    - pymdownx.snippets
+    - pymdownx.superfences
 plugins:
     - search
 nav: