@docusaurus/plugin-content-blog 0.0.0-4892 → 0.0.0-4895

package/lib/index.js

@@ -10,6 +10,7 @@ exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
+const footnoteIDFixer_1 = tslib_1.__importDefault(require("./remark/footnoteIDFixer"));
 const utils_1 = require("@docusaurus/utils");
 const translations_1 = require("./translations");
 const blogUtils_1 = require("./blogUtils");
@@ -281,7 +282,10 @@ async function pluginContentBlog(context, options) {
                                     options: {
                                         remarkPlugins,
                                         rehypePlugins,
-                                        beforeDefaultRemarkPlugins,
+                                        beforeDefaultRemarkPlugins: [
+                                            footnoteIDFixer_1.default,
+                                            ...beforeDefaultRemarkPlugins,
+                                        ],
                                         beforeDefaultRehypePlugins,
                                         staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
                                         siteDir,

package/lib/remark/footnoteIDFixer.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Transformer } from 'unified';
+/**
+ * In the blog list view, each post will be compiled separately. However, they
+ * may use the same footnote IDs. This leads to duplicated DOM IDs and inability
+ * to navigate to footnote references. This plugin fixes it by appending a
+ * unique hash to each reference/definition.
+ */
+export default function plugin(): Transformer;

package/lib/remark/footnoteIDFixer.js

@@ -0,0 +1,29 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const unist_util_visit_1 = tslib_1.__importDefault(require("unist-util-visit"));
+const utils_1 = require("@docusaurus/utils");
+/**
+ * In the blog list view, each post will be compiled separately. However, they
+ * may use the same footnote IDs. This leads to duplicated DOM IDs and inability
+ * to navigate to footnote references. This plugin fixes it by appending a
+ * unique hash to each reference/definition.
+ */
+function plugin() {
+    return (root, vfile) => {
+        const suffix = `-${(0, utils_1.simpleHash)(vfile.path, 6)}`;
+        (0, unist_util_visit_1.default)(root, 'footnoteReference', (node) => {
+            node.identifier += suffix;
+        });
+        (0, unist_util_visit_1.default)(root, 'footnoteDefinition', (node) => {
+            node.identifier += suffix;
+        });
+    };
+}
+exports.default = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4892",
+  "version": "0.0.0-4895",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,12 +18,12 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4892",
-    "@docusaurus/logger": "0.0.0-4892",
-    "@docusaurus/mdx-loader": "0.0.0-4892",
-    "@docusaurus/utils": "0.0.0-4892",
-    "@docusaurus/utils-common": "0.0.0-4892",
-    "@docusaurus/utils-validation": "0.0.0-4892",
+    "@docusaurus/core": "0.0.0-4895",
+    "@docusaurus/logger": "0.0.0-4895",
+    "@docusaurus/mdx-loader": "0.0.0-4895",
+    "@docusaurus/utils": "0.0.0-4895",
+    "@docusaurus/utils-common": "0.0.0-4895",
+    "@docusaurus/utils-validation": "0.0.0-4895",
     "cheerio": "^1.0.0-rc.10",
     "feed": "^4.2.2",
     "fs-extra": "^10.1.0",
@@ -31,11 +31,12 @@
     "reading-time": "^1.5.0",
     "remark-admonitions": "^1.2.1",
     "tslib": "^2.3.1",
+    "unist-util-visit": "^2.0.3",
     "utility-types": "^3.10.0",
     "webpack": "^5.72.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4892",
+    "@docusaurus/types": "0.0.0-4895",
     "escape-string-regexp": "^4.0.0"
   },
   "peerDependencies": {
@@ -45,5 +46,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "babc1ac385126474eafcddd5ce6aecb602ab45db"
+  "gitHead": "8845bdf725b98ed6da91b2270a8a3d268bce3fa4"
 }

package/src/index.ts

@@ -7,6 +7,7 @@
 
 import path from 'path';
 import admonitions from 'remark-admonitions';
+import footnoteIDFixer from './remark/footnoteIDFixer';
 import {
   normalizeUrl,
   docuHash,
@@ -435,7 +436,10 @@ export default async function pluginContentBlog(
                   options: {
                     remarkPlugins,
                     rehypePlugins,
-                    beforeDefaultRemarkPlugins,
+                    beforeDefaultRemarkPlugins: [
+                      footnoteIDFixer,
+                      ...beforeDefaultRemarkPlugins,
+                    ],
                     beforeDefaultRehypePlugins,
                     staticDirs: siteConfig.staticDirectories.map((dir) =>
                       path.resolve(siteDir, dir),

package/src/remark/footnoteIDFixer.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import visit from 'unist-util-visit';
+import {simpleHash} from '@docusaurus/utils';
+import type {Transformer} from 'unified';
+import type {FootnoteReference, FootnoteDefinition} from 'mdast';
+
+/**
+ * In the blog list view, each post will be compiled separately. However, they
+ * may use the same footnote IDs. This leads to duplicated DOM IDs and inability
+ * to navigate to footnote references. This plugin fixes it by appending a
+ * unique hash to each reference/definition.
+ */
+export default function plugin(): Transformer {
+  return (root, vfile) => {
+    const suffix = `-${simpleHash(vfile.path!, 6)}`;
+    visit(root, 'footnoteReference', (node: FootnoteReference) => {
+      node.identifier += suffix;
+    });
+    visit(root, 'footnoteDefinition', (node: FootnoteDefinition) => {
+      node.identifier += suffix;
+    });
+  };
+}