Merge branch 'MarkBind:master' into branch-addFullSearch

MarkBind · Jan 14, 2025 · 2d6e9b3 · 2d6e9b3
2 parents c926255 + 4ed8781
commit 2d6e9b3
Show file tree

Hide file tree

Showing 184 changed files with 276 additions and 256 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -754,6 +754,15 @@
         "code",
         "doc"
       ]
+    },
+    {
+      "login": "Incogdino",
+      "name": "Javier ",
+      "avatar_url": "https://avatars.githubusercontent.com/u/89335739?v=4",
+      "profile": "https://github.com/Incogdino",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -24,7 +24,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
       - name: Install Graphviz
         uses: tlylt/install-graphviz@v1
       - name: Install Java
@@ -48,7 +48,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
       - name: Install Graphviz
         uses: tlylt/install-graphviz@v1
       - name: Install Java
@@ -83,7 +83,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
       - name: Install Graphviz
         uses: tlylt/install-graphviz@v1
       - name: Install Java

diff --git a/README.md b/README.md
@@ -134,6 +134,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/yiwen101"><img src="https://avatars.githubusercontent.com/u/121547057?v=4?s=100" width="100px;" alt="Wang Yiwen"/><br /><sub><b>Wang Yiwen</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=yiwen101" title="Documentation">📖</a> <a href="https://github.com/MarkBind/markbind/commits?author=yiwen101" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ashleeey1224"><img src="https://avatars.githubusercontent.com/u/105656080?v=4?s=100" width="100px;" alt="Ashleeey1224"/><br /><sub><b>Ashleeey1224</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=Ashleeey1224" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://www.linkedin.com/in/gerteck"><img src="https://avatars.githubusercontent.com/u/111064611?v=4?s=100" width="100px;" alt="Ger Teck"/><br /><sub><b>Ger Teck</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=gerteck" title="Code">💻</a> <a href="https://github.com/MarkBind/markbind/commits?author=gerteck" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Incogdino"><img src="https://avatars.githubusercontent.com/u/89335739?v=4?s=100" width="100px;" alt="Javier "/><br /><sub><b>Javier </b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=Incogdino" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

diff --git a/docs/_markbind/variables.md b/docs/_markbind/variables.md
@@ -11,8 +11,8 @@
 <variable name="icon_info">:fas-info-circle:</variable>
 <variable name="icon_ticked">:far-check-square:</variable>
 
-<variable name="node_version_number">16</variable>
-<variable name="node_dev_version_number">16.19.1</variable>
+<variable name="node_version_number">18</variable>
+<variable name="node_dev_version_number">18.20.4</variable>
 <variable name="node_version"><tooltip content="MarkBind aims to support up to the last maintenance lts release as outlined [here](https://nodejs.org/en/about/releases/)">v{{ node_version_number }}</tooltip></variable>
 <variable name="node_dev_version"><tooltip content="MarkBind aims to support up to the last maintenance lts release as outlined [here](https://nodejs.org/en/about/releases/)">v{{ node_dev_version_number }}</tooltip></variable>
 <variable name="graphviz_version_number">2.38</variable>

diff --git a/docs/about.md b/docs/about.md
@@ -139,6 +139,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/yiwen101"><img src="https://avatars.githubusercontent.com/u/121547057?v=4?s=100" width="100px;" alt="Wang Yiwen"/><br /><sub><b>Wang Yiwen</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=yiwen101" title="Documentation">📖</a> <a href="https://github.com/MarkBind/markbind/commits?author=yiwen101" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ashleeey1224"><img src="https://avatars.githubusercontent.com/u/105656080?v=4?s=100" width="100px;" alt="Ashleeey1224"/><br /><sub><b>Ashleeey1224</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=Ashleeey1224" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://www.linkedin.com/in/gerteck"><img src="https://avatars.githubusercontent.com/u/111064611?v=4?s=100" width="100px;" alt="Ger Teck"/><br /><sub><b>Ger Teck</b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=gerteck" title="Code">💻</a> <a href="https://github.com/MarkBind/markbind/commits?author=gerteck" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Incogdino"><img src="https://avatars.githubusercontent.com/u/89335739?v=4?s=100" width="100px;" alt="Javier "/><br /><sub><b>Javier </b></sub></a><br /><a href="https://github.com/MarkBind/markbind/commits?author=Incogdino" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

diff --git a/docs/devGuide/development/settingUp.md b/docs/devGuide/development/settingUp.md
@@ -16,7 +16,7 @@ This page explains how to set up your development environment to start contribut
 ## Prerequisites
 
 1. **Node.js** ({{ node_dev_version }} or higher) with<br>
-   **npm** v8 or higher
+   a recent version of **npm**
 
 1. **Java** 8 or higher, and<br>
    **Graphviz** ({{ graphviz_version }} or higher, _installation is optional on Windows_) <br>
@@ -32,10 +32,6 @@ This page explains how to set up your development environment to start contribut
    * `dot -V` (for Graphviz - optional on Windows)
    * `python3 -V`
 
-<box type="warning" seamless>
-
-With Node LTS (v20), the python used has updated to 3.12, and [you may get an error](https://github.com/MarkBind/markbind/issues/2496). You can solve this issue by installing setuptools or deprecating the versions used.
-</box>
 <box type="tip" seamless>
 
 We recommend the **WebStorm IDE** or **VS Code** for working with MarkBind code.

diff --git a/docs/userGuide/deployingTheSite.md b/docs/userGuide/deployingTheSite.md
@@ -113,7 +113,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
       - run: npm i -g markbind-cli
       - run: markbind deploy --ci
 ```
@@ -201,7 +201,7 @@ Since May 2018, Travis CI has been [undergoing migration to `travis-ci.com`](htt
     ```yml
     language: node_js
     node_js:
-      - 16
+      - 18
     install:
       - npm i -g markbind-cli
     script: markbind build
@@ -269,7 +269,7 @@ The `repo` value can be changed to your specific repository as desired.
 
     ```yml
     environment:
-      nodejs_version: '16'
+      nodejs_version: '18'
     
     branches:
       only:
@@ -316,8 +316,8 @@ Commit and push `appveyor.yml` to your GitHub repository. Thereafter, AppVeyor C
         steps:
           - checkout
           - node/install:
-              node-version: "16"
-              npm-version: "8"
+              node-version: "18"
+              npm-version: "10"
               install-yarn: false
           - run: node --version
           - run: npm i -g markbind-cli
@@ -436,7 +436,7 @@ jobs:
       - name: Install Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - name: Build MarkBind website
         run: |
           npm install -g markbind-cli
@@ -506,7 +506,7 @@ jobs:
       - name: Install Node
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
       - name: Build PR preview url
         id: pr-url
         run: |

diff --git a/docs/userGuide/gettingStarted.md b/docs/userGuide/gettingStarted.md
@@ -19,11 +19,6 @@
   %%{{ icon_ticked }}%% [Node.js](https://nodejs.org) {{ node_version }} or higher installed
 </div>
 
-<box type="warning" seamless>
-
-With Node LTS (v20), the python used has updated to 3.12, and [you may get an error](https://github.com/MarkBind/markbind/issues/2496). You can solve this issue by installing setuptools or deprecating the versions used.
-</box>
-
 There are a few ways to install MarkBind, select one that is most suitable for your use case. If you are unsure, we recommend using the first method.
 
 ## Method 1: Install MarkBind globally with npm

diff --git a/docs/userGuide/syntax/annotations.md b/docs/userGuide/syntax/annotations.md
@@ -72,17 +72,12 @@ Style the shape to achieve the same effect.
 
 <include src="codeAndOutput.md" boilerplate>
 <variable name="code">
-
 <annotate src="../../images/annotateSampleImage.png" width="500" alt="Sample Image">
-  <a-point x="75%" y="50%" content="This point is 75% from the left and 50% from the top">
-    <span class="badge bg-primary">Badge label</span>
-  </a-point>
-  <a-point x="25%" y="50%" content="This point is 25% from the left and 50% from the top">
-    <pic src="../../images/deer.jpg" width="50" height="50">
+  <a-point x="40%" y="-2%" content="Look within this box">
+    <div style="width: 330px; height: 150px; border: 2px solid red; margin: 20px auto;"></div>
   </a-point>
-  <!-- Customised Annotate Point with styling-->
-  <a-point x="50%" y="50%" content="This point is 25% from the left and 50% from the top">
-    <div style="opacity: 90%; color: red">Custom</div>
+  <a-point x="50%" y="75%" content="You should pay attention to this!">
+    <div style="opacity: 90%; color: red; font-size: 40px">!!</div>
   </a-point>
 </annotate>
 </variable>

diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "5.5.2",
+  "version": "5.5.3",
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
   "useWorkspaces": true
 }
diff --git a/netlify.toml b/netlify.toml
@@ -1,3 +1,3 @@
 [build]
   command = "npm run deploy:netlify"
-  environment = { NODE_VERSION = "16.19.1"}
+  environment = { NODE_VERSION = "18.20.4"}
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "markbind-cli",
-  "version": "5.5.2",
+  "version": "5.5.3",
   "description": "Command line interface for MarkBind",
   "keywords": [
     "mark",
@@ -25,8 +25,8 @@
     "updatetest": "cd test/functional && node updatetest.js"
   },
   "dependencies": {
-    "@markbind/core": "5.5.2",
-    "@markbind/core-web": "5.5.2",
+    "@markbind/core": "5.5.3",
+    "@markbind/core-web": "5.5.3",
     "bluebird": "^3.7.2",
     "chalk": "^3.0.0",
     "cheerio": "^0.22.0",

diff --git a/packages/cli/test/functional/test_site/expected/bugs/index.html b/packages/cli/test/functional/test_site/expected/bugs/index.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Open Bugs</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/index.html b/packages/cli/test/functional/test_site/expected/index.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Hello World</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/markbind/css/markbind.min.css b/packages/cli/test/functional/test_site/expected/markbind/css/markbind.min.css
diff --git a/packages/cli/test/functional/test_site/expected/markbind/js/markbind.min.js b/packages/cli/test/functional/test_site/expected/markbind/js/markbind.min.js
diff --git a/packages/cli/test/functional/test_site/expected/sub_site/index.html b/packages/cli/test/functional/test_site/expected/sub_site/index.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">
   <link rel="stylesheet" href="/test_site/markbind/fontawesome/css/all.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/sub_site/nested_sub_site/index.html b/packages/cli/test/functional/test_site/expected/sub_site/nested_sub_site/index.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">
   <link rel="stylesheet" href="/test_site/markbind/fontawesome/css/all.min.css">

diff --git a/...est/functional/test_site/expected/sub_site/nested_sub_site/testNunjucksPathResolving.html b/...est/functional/test_site/expected/sub_site/nested_sub_site/testNunjucksPathResolving.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Hello World</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/sub_site/testNunjucksPathResolving.html b/packages/cli/test/functional/test_site/expected/sub_site/testNunjucksPathResolving.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Hello World</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/testAltFrontMatterInvalidKeyValue.html b/packages/cli/test/functional/test_site/expected/testAltFrontMatterInvalidKeyValue.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Hello World</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/testAltFrontMatterParsing.html b/packages/cli/test/functional/test_site/expected/testAltFrontMatterParsing.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>new title</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/testAnchorGeneration.html b/packages/cli/test/functional/test_site/expected/testAnchorGeneration.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Anchor Generation Test</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/testAnnotate.html b/packages/cli/test/functional/test_site/expected/testAnnotate.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Annotate Feature Test</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">

diff --git a/packages/cli/test/functional/test_site/expected/testAntiFOUCStyles.html b/packages/cli/test/functional/test_site/expected/testAntiFOUCStyles.html
@@ -8,7 +8,7 @@
 
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="generator" content="MarkBind 5.5.2">
+  <meta name="generator" content="MarkBind 5.5.3">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Hello World</title>
   <link rel="stylesheet" href="/test_site/markbind/css/bootstrap.min.css">