Adds runme badge plugin

Author: pastuxso

docusaurus.config.js

@@ -96,6 +96,12 @@ const config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl: "https://github.com/stateful/docs.runme.dev/edit/main",
+          remarkPlugins: [
+            [
+              require("./runme-badge-plugin.js"),
+              { repository: "https://github.com/stateful/docs.runme.dev.git" },
+            ],
+          ],
         },
         blog: {
           showReadingTime: true,

package-lock.json

@@ -19,10 +19,12 @@
     "@docusaurus/preset-classic": "3.1.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.1.0",
+    "js-yaml": "^4.1.0",
     "prism-react-renderer": "^2.3.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
-    "react-timeout": "^2.0.1"
+    "react-timeout": "^2.0.1",
+    "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.1.1",

package.json

@@ -0,0 +1,47 @@
+const { visit } = require("unist-util-visit");
+const path = require("node:path");
+const yaml = require("js-yaml");
+
+const runmePlugin = ({ repository }) => {
+  if (!repository) {
+    throw new Error("repository is required");
+  }
+
+  const transformer = async (ast, vfile) => {
+    const markdownPath = vfile.path.replace(`${vfile.cwd}${path.sep}`, "");
+    let isRunmeFile = false;
+
+    visit(ast, "yaml", (node, index, parent) => {
+      const yml = yaml.load(node.value);
+      if (yml?.runme) {
+        isRunmeFile = true;
+      }
+    });
+
+    if (!isRunmeFile) {
+      return;
+    }
+
+    visit(ast, "root", (node, index, parent) => {
+      node.children.unshift({
+        type: "link",
+        url: `https://runme.dev/api/runme?repository=${encodeURIComponent(
+          repository
+        )}&fileToOpen=${markdownPath}`,
+        title: "Open with runme",
+        children: [
+          {
+            type: "image",
+            title: "Open with runme",
+            url: "https://badgen.net/badge/Open%20with/Runme/5B3ADF?icon=https://runme.dev/img/logo.svg",
+            alt: "Runme badget",
+          },
+        ],
+      });
+    });
+  };
+
+  return transformer;
+};
+
+module.exports = runmePlugin;