Merge branch 'develop-2.x' into develop-2.x

Author: amejia1

.github/workflows/docslint-v2.yml

@@ -0,0 +1,46 @@
+name: Lint documentation (Ferron 2.x)
+
+on:
+  push:
+    branches: ["develop-2.x"]
+    paths:
+      - "docs/**/*.md"
+      - ".github/workflows/docslint-v2.yml"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          ref: develop-2.x
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install rumdl
+        if: matrix.command != 'cross'
+        shell: bash
+        run: |
+          curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
+          cargo binstall --no-confirm rumdl --force
+
+      - name: Lint and format documentation
+        shell: bash
+        run: |
+          rumdl fmt docs
+          rumdl check --fix docs
+
+      - name: Commit fixed documentation
+        if: "!cancelled()"
+        shell: bash
+        run: |
+          git config --local user.name "github-actions[bot]"
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          if ! git diff --quiet docs; then
+            git add docs
+            git commit -m 'docs: fix lint errors and format the documentation [skip ci]'
+            git push origin main
+          fi

.rumdl.toml

@@ -0,0 +1,59 @@
+# rumdl configuration file
+
+# Global configuration options
+[global]
+# List of rules to disable (uncomment and modify as needed)
+disable = ["MD013", "MD033"]
+
+# List of rules to enable exclusively (if provided, only these rules will run)
+# enable = ["MD001", "MD003", "MD004"]
+
+# List of file/directory patterns to include for linting (if provided, only these will be linted)
+# include = [
+#    "docs/*.md",
+#    "src/**/*.md",
+#    "README.md"
+# ]
+
+# List of file/directory patterns to exclude from linting
+exclude = [
+    # Common directories to exclude
+    ".git",
+    ".github",
+    "node_modules",
+    "vendor",
+    "dist",
+    "build",
+
+    # Specific files or patterns
+    "CHANGELOG.md",
+    "LICENSE.md",
+]
+
+# Respect .gitignore files when scanning directories (default: true)
+respect-gitignore = true
+
+# Markdown flavor/dialect (uncomment to enable)
+# Options: standard (default), gfm, commonmark, mkdocs, mdx, quarto
+# flavor = "mkdocs"
+
+# Rule-specific configurations (uncomment and modify as needed)
+
+# [MD003]
+# style = "atx"  # Heading style (atx, atx_closed, setext)
+
+# [MD004]
+# style = "asterisk"  # Unordered list style (asterisk, plus, dash, consistent)
+
+# [MD007]
+# indent = 4  # Unordered list indentation
+
+# [MD013]
+# line-length = 100  # Line length
+# code-blocks = false  # Exclude code blocks from line length check
+# tables = false  # Exclude tables from line length check
+# headings = true  # Include headings in line length check
+
+# [MD044]
+# names = ["rumdl", "Markdown", "GitHub"]  # Proper names that should be capitalized correctly
+# code-blocks = false  # Check code blocks for proper names (default: false, skips code blocks)

.shiba/pre-commit

@@ -11,6 +11,13 @@ if git diff --name-only --cached | grep -qE ".*\.rs$|(^|/)Cargo\.(lock|toml)$";
   cargo fmt || exit $?
 fi
 
+for file in $(git diff --name-only --cached | grep -qE "docs/.*\.md$"); do
+  if rumdl fmt $file; then
+    rumdl check --fix $file || exit $?
+    git add $file
+  fi
+done
+
 cargo shear --fix || true
 
 for rust_file in $(comm -12 <(git diff --name-only --cached | sort) <(git diff --name-only | sort) | grep ".*\.rs$"); do

docs/README.md

@@ -1,3 +1,3 @@
 # Ferron documentation
 
-This directory contains the documentation for the Ferron web server. If you're looking for the server documentation, you can go to https://ferron.sh/docs.
+This directory contains the documentation for the Ferron web server. If you're looking for the server documentation, you can go to <https://ferron.sh/docs>.

docs/commands.md

@@ -8,7 +8,7 @@ Ferron comes with several additional command-line tools.
 
 ### `ferron`
 
-```plain
+```text
 A fast, memory-safe web server written in Rust
 
 Usage: ferron [OPTIONS] [COMMAND]
@@ -50,7 +50,7 @@ Options:
 
 ### `ferron-passwd`
 
-```
+```text
 A password tool for Ferron
 
 Usage: ferron-passwd
@@ -62,7 +62,7 @@ Options:
 
 ### `ferron-precompress`
 
-```
+```text
 A utility that precompresses static files for Ferron
 
 Usage: ferron-precompress [OPTIONS] <assets>...
@@ -78,7 +78,7 @@ Options:
 
 ### `ferron-yaml2kdl`
 
-```
+```text
 A utility that attempts to convert Ferron 1.x YAML configuration to Ferron 2.x KDL configuration
 
 Usage: ferron-yaml2kdl <input> <output>

docs/configuration-kdl.md

@@ -287,7 +287,7 @@ This configuration reference organizes directives by both **scope** (where they
 
 - `auth_to_concurrent_conns <auth_to_concurrent_conns: integer|null>` (_fauth_ module; Ferron 2.4.0 or newer)
   - This directive specifies the limit of TCP connections being established to backend servers (for forwarded authentication), to prevent exhaustion of network resources. If set as `auth_to_concurrent_conns #null`, the reverse proxy can theoretically establish an unlimited number of connections. Default: `auth_to_concurrent_conns 16384`
-  
+
 **Configuration example:**
 
 ```kdl

docs/installation/manual.md

@@ -72,10 +72,13 @@ kill -HUP $(pidof ferron)
 
   The `ferron-passwd` tool assists in generating user entries with hashed passwords for secure configurations. To use it:
   - **Unix-like Systems**:
+
     ```bash
     ./ferron-passwd someuser
     ```
+
   - **Windows**:
+
     ```cmd
     ferron-passwd.exe someuser
     ```

docs/use-cases/redirecting.md

@@ -20,7 +20,7 @@ example.org {
 }
 ```
 
-### Redirecting from URL without "www." to URL with "www."
+## Redirecting from URL without "www." to URL with "www."
 
 If you want to redirect all requests from an URL without "www." to URL with "www.", you can use this configuration: