Merge remote-tracking branch 'origin/main' into yordis/md-formatter

Author: yordis

.github/workflows/artifacts.yml

@@ -0,0 +1,73 @@
+name: Artifacts
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+    branches-ignore:
+      - main
+
+permissions:
+  pull-requests: write
+
+jobs:
+  notify:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.event == 'pull_request' }}
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            const artifacts = await github.rest.actions.listWorkflowRunArtifacts({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              run_id: context.payload.workflow_run.id
+            });
+
+            if (artifacts.data.total_count !== 1) {
+              throw new Error('Expected one artifact')
+            }
+
+            const artifact = artifacts.data.artifacts[0];
+            const download = await github.rest.actions.downloadArtifact({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              artifact_id: artifact.id,
+              archive_format: 'zip'
+            });
+
+            const fs = require('fs');
+            fs.writeFileSync('artifact.zip', Buffer.from(download.data));
+            require('child_process').execSync('unzip artifact.zip');
+            const ghInfo = JSON.parse(fs.readFileSync('gh.json', 'utf8'));
+            const pullNumber = ghInfo.number;
+
+            const artifactUrl = `${context.payload.workflow_run.html_url}/artifacts/${artifact.id}`;
+            const commentBody = `<!-- build-artifact-comment -->\n📦 Docs artifacts are ready: ${artifactUrl}`;
+
+            const comments = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: pullNumber
+            });
+
+            const botComment = comments.data.find(comment =>
+              comment.user.type === 'Bot' &&
+                comment.body.includes('<!-- build-artifact-comment -->')
+            );
+
+            if (botComment) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: botComment.id,
+                body: commentBody
+              });
+            } else {
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: pullNumber,
+                body: commentBody
+              });
+            }

.github/workflows/ci.yml

@@ -1,104 +1,109 @@
 name: CI
 
-on:
-  pull_request:
-  push:
+on: [pull_request, push]
 
 env:
-  node-version: 18.x
+  MIX_ENV: test
 
 jobs:
-  mix_test:
-    runs-on: ubuntu-20.04
-    env:
-      MIX_ENV: test
+  assets:
+    runs-on: ubuntu-latest
     strategy:
-      fail-fast: false
       matrix:
         include:
-          - pair: # Test very old Elixir and Erlang
-              elixir: "1.14"
-              otp: "25"
-          - pair: # Test Erlang without -doc attribute support
-              elixir: "1.16"
-              otp: "26"
-          - pair: # Test Erlang with -doc attribute support
-              elixir: "1.17"
-              otp: "27"
-            lint: lint
+          - elixir: "1.17"
+            otp: "27"
+            node: 18.x
     steps:
       - uses: actions/checkout@v3
 
-      - uses: erlef/setup-beam@v1
+      # Setup Node
+      - uses: actions/setup-node@v3
         with:
-          otp-version: ${{matrix.pair.otp}}
-          elixir-version: ${{matrix.pair.elixir}}
-
-      - name: Install Dependencies
-        run: mix deps.get
-
-      - run: mix format --check-formatted
-        if: ${{ matrix.lint }}
-
-      - run: mix deps.unlock --check-unused
-        if: ${{ matrix.lint }}
+          node-version: ${{matrix.node}}
 
-      - run: mix deps.compile
+      - name: Cache npm dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('asssets/package-lock.json') }}
 
-      - run: mix compile --warnings-as-errors
-        if: ${{ matrix.lint }}
+      - run: npm ci --prefix assets
+      - run: npm run build --prefix assets
 
-      - run: mix test
+      # Setup Elixir
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{ matrix.otp }}
+          elixir-version: ${{ matrix.elixir }}
 
-      - name: Prerelease
+      # Generate and upload artifacts
+      - name: Generate docs
         run: test/prerelease.sh
 
-      - name: Generate docs
+      - name: Attach docs metadata
         run: |
-          mix docs
-          test -f doc/index.html && echo "doc/index.html exists."
-          test -f doc/ExDoc.epub && echo "doc/ExDoc.epub exists."
+          echo "{\"number\":${{ github.event.number }}}" > test/tmp/contents/doc/gh.json
 
-  check_js:
-    name: Check JS
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ env.node-version }}
-      - name: Cache npm dependencies
-        uses: actions/cache@v3
+      - name: Upload docs
+        uses: actions/upload-artifact@v4
+        id: docs-upload
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('asssets/package-lock.json') }}
-      - run: npm install --prefix assets
+          name: docs
+          path: test/tmp/contents/doc/
+
+      # Test JS
       - run: npm run lint --prefix assets
-      - run: sudo apt-get install xvfb
-      - run: |
+      - name: npm run test --prefix assets
+        run: |
+          sudo apt-get install xvfb
           xvfb-run --auto-servernum npm run test --prefix assets
         env:
           CI: true
 
-  assets:
-    needs: [check_js]
-    runs-on: ubuntu-20.04
-    if: github.ref_name == 'main'
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ env.node-version }}
-      - name: Cache npm dependencies
-        uses: actions/cache@v3
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('asssets/package-lock.json') }}
-      - run: mkdir -p tmp/handlebars
-      - run: npm ci --prefix assets
-      - run: npm run build --prefix assets
+      # Push updated assets if all good
       - name: Push updated assets
+        if: github.ref_name == 'main'
         uses: stefanzweifel/git-auto-commit-action@v4
         with:
           commit_message: Update assets
           file_pattern: formatters
+
+  elixir:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Test very old Elixir and Erlang
+          - elixir: "1.15"
+            otp: "25"
+          # Test Erlang without -doc attribute support
+          - elixir: "1.16"
+            otp: "26"
+          # Test with initial Erlang doc attribute support
+          - elixir: "1.17"
+            otp: "27"
+          - elixir: "1.18"
+            otp: "27"
+            lint: true
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{ matrix.otp }}
+          elixir-version: ${{ matrix.elixir }}
+
+      - run: mix deps.get
+
+      - run: mix compile --warnings-as-errors
+        if: ${{ matrix.lint }}
+
+      - run: mix test
+
+      - run: mix deps.unlock --check-unused
+        if: ${{ matrix.lint }}
+
+      - run: mix format --check-formatted
+        if: ${{ matrix.lint }}

.github/workflows/release.yml

@@ -36,8 +36,8 @@ jobs:
             otp_version: "26.2.5"
             elixir_version: "1.16.2"
           - otp: 27
-            otp_version: "27.0"
-            elixir_version: "1.17.0"
+            otp_version: "27.2"
+            elixir_version: "1.18.2"
 
     runs-on: ubuntu-22.04
     steps:

CHANGELOG.md

@@ -1,5 +1,82 @@
 # Changelog
 
+## v0.38.4 (2025-09-09)
+
+  * Bug fixes
+    * Fix escaping of links when they have ampersand in them
+    * Increase spacing of footers in pages
+    * Align stale icon positioning
+
+## v0.38.3 (2025-08-17)
+
+  * Enhancements
+    * Allow configuring autocomplete limit, and default it to 10 instead of 8
+    * Display description text in docs groups
+    * Load discovered makeup apps for CLI
+
+## v0.38.2 (2025-05-27)
+
+  * Bug fixes
+    * Render documents with hardcoded `<h2>`/`<h3>` entries correctly
+    * Fix padding on external links
+
+## v0.38.1 (2025-05-12)
+
+  * Bug fixes
+    * Ensure stripping apps for Erlang sources emit valid AST
+
+## v0.38.0 (2025-05-09)
+
+  * Enhancements
+    * Allow listing outside URLs in extras
+
+  * Bug fixes
+    * Ensure some cases where `<`, `>`, `&` and in headers would appear as entities in the sidebar
+    * Fix outline caused by swup.js on Webkit based browsers
+    * Fix bugs when computing synopsis
+    * Automatically close the sidebar when navigating sections on mobile
+
+## v0.37.3 (2025-03-06)
+
+  * Bug fixes
+    * Handle `http-equiv=refresh` during Swup.js navigation
+    * Include full error description when syntax highlighting fails
+
+## v0.37.2 (2025-02-19)
+
+  * Bug fixes
+    * Fix code highlighting for languages with non-alphanumeric characters
+
+## v0.37.1 (2025-02-10)
+
+  * Enhancements
+    * Support umbrella projects via the CLI
+
+  * Bug fixes
+    * Make sure docs are rendered inside iframes
+
+## v0.37.0 (2025-02-05)
+
+Thanks to @liamcmitchell and @hichemfantar for the extensive contributions in this new release.
+
+  * Enhancements
+    * Optimize and parallelize module retriever, often leading to 20x-30x faster docs generation
+    * Considerably improve page loading times in the browser
+    * Allow customizing `search_data` for extra pages
+    * Use native style for scroll bars
+    * Enhance links between extras/pages/guides with padding and hover effects
+    * Go to latest goes to the same page if it exists, root otherwise
+    * Apply new style and layout for tabs
+    * Increase font-weight on sidebar on Apple machines/devices
+    * Improve accessibility across deprecation, links, and summaries
+    * Add compatibility to Erlang/OTP 28+
+    * Rely on the operating system monospace font for unified experience and better load times
+    * Introduce `"exdoc:loaded"` window event to track navigation
+    * Support for favicons
+
+  * Bug fixes
+    * Move action links out from heading tags
+
 ## v0.36.1 (2024-12-24)
 
   * Enhancements
@@ -190,7 +267,7 @@ This release requires Elixir v1.13.
 ## v0.30.6 (2023-08-25)
 
   * Enhancements
-    * Extract title from Markdown file when preceeded with comments
+    * Extract title from Markdown file when preceded with comments
     * Improve focus navigation in notebooks
 
 ## v0.30.5 (2023-08-12)
@@ -333,7 +410,7 @@ This release requires Elixir v1.13.
 
 ## v0.28.3 (2022-03-23)
 
-  * Enhacements
+  * Enhancements
     * Include page titles in autocomplete suggestions
     * Allow theme to be set to "System" version
     * Remove "Specs" heading and render full typespecs

Cheatsheet.cheatmd

@@ -47,6 +47,10 @@ Paragraphs are visually distinct from one another.
 | `%A, %B %e, %Y` | `Sunday, June 5, 2013` |
 | `%b %e %a`      | `Jun 5 Sun`            |
 
+### [Link](`mix docs`)
+
+Header with links in it.
+
 ## Variants
 {: .col-2}