New docs site

Author: maximegosselin

.github/workflows/deploy.yml

@@ -1,39 +1,63 @@
-name: Deploy Documentation
+name: Deploy to Pages
 
 on:
     push:
         branches:
             - 2.x
-
+    workflow_dispatch:
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+concurrency:
+    group: "pages"
+    cancel-in-progress: false
+defaults:
+    run:
+        shell: bash
 jobs:
-    deploy:
+    build:
         runs-on: ubuntu-latest
-
+        env:
+            HUGO_VERSION: 0.126.0
         steps:
-            - name: Checkout source
-              uses: actions/checkout@v4
-              with:
-                  submodules: recursive
-                  fetch-depth: 0
-
-            - name: Setup Hugo
-              uses: peaceiris/actions-hugo@v3
-              with:
-                  hugo-version: 'latest'
-                  extended: true
-
-            - name: Build Hugo site
-              run: |
-                  cd docs
-                  hugo --minify
-
-            - name: Deploy to GitHub Pages
-              uses: peaceiris/actions-gh-pages@v4
-              with:
-                  personal_token: ${{ secrets.DEPLOY_TOKEN }}
-                  external_repository: backslashphp/backslashphp.github.io
-                  publish_branch: main
-                  publish_dir: ./docs/public
-                  cname: backslashphp.github.io
-                  user_name: 'github-actions[bot]'
-                  user_email: 'github-actions[bot]@users.noreply.github.com'
+            -   name: Install Hugo CLI
+                run: |
+                    wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+                    && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+            -   name: Install Dart Sass
+                run: sudo snap install dart-sass
+            -   name: Checkout
+                uses: actions/checkout@v4
+                with:
+                    submodules: recursive
+                    fetch-depth: 0
+            -   name: Setup Node.js
+                uses: actions/setup-node@v4
+                with:
+                    node-version: '20'
+                    cache: 'npm'
+            -   name: Setup Pages
+                id: pages
+                uses: actions/configure-pages@v4
+            -   name: Install dependencies
+                run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
+            -   name: Build production website
+                env:
+                    HUGO_ENVIRONMENT: production
+                    HUGO_ENV: production
+                    TZ: America/Toronto
+                run: |
+                    npm run build \
+                      -- \
+                      --baseURL "${{ steps.pages.outputs.base_url }}/"
+            -   name: Copy to backslashphp/backslashphp.github.io
+                uses: peaceiris/actions-gh-pages@v4
+                with:
+                    personal_token: ${{ secrets.DEPLOY_TOKEN }}
+                    external_repository: backslashphp/backslashphp.github.io
+                    publish_branch: main
+                    publish_dir: ./docs/public
+                    cname: backslashphp.github.io
+                    user_name: 'github-actions[bot]'
+                    user_email: 'github-actions[bot]@users.noreply.github.com'

docs/.gitignore

@@ -1,3 +1,6 @@
-/public/
-/resources/
+.env
+.netlify
 .hugo_build.lock
+node_modules
+public
+resources

docs/.gitmodules

@@ -0,0 +1,2 @@
+!.npmrc
+!.gitignore

docs/.npmignore

@@ -0,0 +1,4 @@
+enable-pre-post-scripts=true
+auto-install-peers=true
+node-linker=hoisted
+prefer-symlinked-executables=false

docs/.npmrc

@@ -0,0 +1,12 @@
+*.html
+*.ico
+*.png
+*.jp*g
+*.toml
+*.*ignore
+*.svg
+*.xml
+LICENSE
+.npmrc
+.gitkeep
+*.woff*

docs/.prettierignore

@@ -0,0 +1,19 @@
+# Default config
+tabWidth: 4
+endOfLine: crlf
+singleQuote: true
+printWidth: 100000
+trailingComma: none
+bracketSameLine: true
+quoteProps: consistent
+experimentalTernaries: true
+
+# Overrided config
+overrides:
+  - files: ["*.md", "*.json", "*.yaml"]
+    options:
+      tabWidth: 2
+      singleQuote: false
+  - files: ["*.scss"]
+    options:
+      singleQuote: false

docs/.prettierrc.yaml

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2025 Thulite
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.