@opensyntaxhq/autodocs-plugin-markdown 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,10 @@
+import { Plugin } from '@opensyntaxhq/autodocs-core';
+
+interface MarkdownPluginOptions {
+    sourceDir: string;
+    patterns?: string[];
+    frontMatter?: boolean;
+}
+declare function markdownPlugin(options: MarkdownPluginOptions): Plugin;
+
+export { type MarkdownPluginOptions, markdownPlugin as default, markdownPlugin };

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { Plugin } from '@opensyntaxhq/autodocs-core';
+
+interface MarkdownPluginOptions {
+    sourceDir: string;
+    patterns?: string[];
+    frontMatter?: boolean;
+}
+declare function markdownPlugin(options: MarkdownPluginOptions): Plugin;
+
+export { type MarkdownPluginOptions, markdownPlugin as default, markdownPlugin };

package/dist/index.js

@@ -0,0 +1,158 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => markdownPlugin,
+  markdownPlugin: () => markdownPlugin
+});
+module.exports = __toCommonJS(index_exports);
+var import_promises6 = __toESM(require("fs/promises"));
+var import_path10 = __toESM(require("path"));
+var import_gray_matter = __toESM(require("gray-matter"));
+var import_marked = require("marked");
+var import_glob = require("glob");
+
+// ../../core/src/parser/index.ts
+var import_typescript = __toESM(require("typescript"));
+var import_path = __toESM(require("path"));
+var import_fs = __toESM(require("fs"));
+
+// ../../core/src/extractor/index.ts
+var import_typescript5 = __toESM(require("typescript"));
+var import_path3 = __toESM(require("path"));
+
+// ../../core/src/parser/utils.ts
+var import_typescript2 = __toESM(require("typescript"));
+
+// ../../core/src/extractor/serializers.ts
+var import_typescript4 = __toESM(require("typescript"));
+var import_crypto = __toESM(require("crypto"));
+var import_path2 = __toESM(require("path"));
+
+// ../../core/src/extractor/utils.ts
+var import_typescript3 = __toESM(require("typescript"));
+
+// ../../core/src/generators/json/index.ts
+var import_promises = __toESM(require("fs/promises"));
+var import_path4 = __toESM(require("path"));
+
+// ../../core/src/version.ts
+var VERSION = "1.0.0";
+
+// ../../core/src/generators/markdown/index.ts
+var import_promises2 = __toESM(require("fs/promises"));
+var import_path5 = __toESM(require("path"));
+
+// ../../core/src/generators/html/index.ts
+var import_promises3 = __toESM(require("fs/promises"));
+var import_path6 = __toESM(require("path"));
+
+// ../../core/src/cache/FileCache.ts
+var import_promises4 = __toESM(require("fs/promises"));
+var import_path7 = __toESM(require("path"));
+var import_crypto2 = __toESM(require("crypto"));
+
+// ../../core/src/cache/incremental.ts
+var import_typescript6 = __toESM(require("typescript"));
+var import_path8 = __toESM(require("path"));
+var import_fs2 = __toESM(require("fs"));
+
+// ../../core/src/deploy/static.ts
+var import_promises5 = __toESM(require("fs/promises"));
+var import_path9 = __toESM(require("path"));
+
+// src/index.ts
+function markdownPlugin(options) {
+  const files = [];
+  return {
+    name: "@opensyntaxhq/autodocs-plugin-markdown",
+    version: VERSION,
+    async initialize(context) {
+      context.logger.info("Initializing markdown plugin");
+      const patterns = options.patterns || ["**/*.md"];
+      const foundFiles = await (0, import_glob.glob)(patterns, {
+        cwd: options.sourceDir,
+        absolute: true,
+        nodir: true
+      });
+      for (const file of foundFiles) {
+        const content = await import_promises6.default.readFile(file, "utf-8");
+        let frontMatter = {};
+        let markdown = content;
+        if (options.frontMatter !== false) {
+          const parsed = (0, import_gray_matter.default)(content);
+          frontMatter = parsed.data;
+          markdown = parsed.content;
+        }
+        const rendered = import_marked.marked.parse(markdown);
+        const html = typeof rendered === "string" ? rendered : await rendered;
+        files.push({
+          path: file,
+          frontMatter,
+          markdown,
+          html
+        });
+      }
+      context.logger.info(`Found ${files.length.toString()} markdown files`);
+      context.cache.set("markdown:files", files);
+    },
+    afterExtract(docs) {
+      const guideDocs = files.map((file) => {
+        const fileName = import_path10.default.basename(file.path, import_path10.default.extname(file.path));
+        const title = typeof file.frontMatter.title === "string" ? file.frontMatter.title : fileName;
+        const description = typeof file.frontMatter.description === "string" ? file.frontMatter.description : "";
+        return {
+          id: `guide:${file.path}`,
+          name: title,
+          kind: "guide",
+          fileName: file.path,
+          source: { file: file.path, line: 1, column: 0 },
+          position: { line: 1, column: 0 },
+          signature: "",
+          documentation: {
+            summary: description,
+            tags: []
+          },
+          metadata: {
+            markdown: file.markdown,
+            html: file.html,
+            frontMatter: file.frontMatter
+          }
+        };
+      });
+      return [...docs, ...guideDocs];
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  markdownPlugin
+});

package/dist/index.mjs

@@ -0,0 +1,123 @@
+// src/index.ts
+import fs8 from "fs/promises";
+import path10 from "path";
+import matter from "gray-matter";
+import { marked } from "marked";
+import { glob } from "glob";
+
+// ../../core/src/parser/index.ts
+import ts from "typescript";
+import path from "path";
+import fs from "fs";
+
+// ../../core/src/extractor/index.ts
+import ts5 from "typescript";
+import path3 from "path";
+
+// ../../core/src/parser/utils.ts
+import ts2 from "typescript";
+
+// ../../core/src/extractor/serializers.ts
+import ts4 from "typescript";
+import crypto from "crypto";
+import path2 from "path";
+
+// ../../core/src/extractor/utils.ts
+import ts3 from "typescript";
+
+// ../../core/src/generators/json/index.ts
+import fs2 from "fs/promises";
+import path4 from "path";
+
+// ../../core/src/version.ts
+var VERSION = "1.0.0";
+
+// ../../core/src/generators/markdown/index.ts
+import fs3 from "fs/promises";
+import path5 from "path";
+
+// ../../core/src/generators/html/index.ts
+import fs4 from "fs/promises";
+import path6 from "path";
+
+// ../../core/src/cache/FileCache.ts
+import fs5 from "fs/promises";
+import path7 from "path";
+import crypto2 from "crypto";
+
+// ../../core/src/cache/incremental.ts
+import ts6 from "typescript";
+import path8 from "path";
+import fs6 from "fs";
+
+// ../../core/src/deploy/static.ts
+import fs7 from "fs/promises";
+import path9 from "path";
+
+// src/index.ts
+function markdownPlugin(options) {
+  const files = [];
+  return {
+    name: "@opensyntaxhq/autodocs-plugin-markdown",
+    version: VERSION,
+    async initialize(context) {
+      context.logger.info("Initializing markdown plugin");
+      const patterns = options.patterns || ["**/*.md"];
+      const foundFiles = await glob(patterns, {
+        cwd: options.sourceDir,
+        absolute: true,
+        nodir: true
+      });
+      for (const file of foundFiles) {
+        const content = await fs8.readFile(file, "utf-8");
+        let frontMatter = {};
+        let markdown = content;
+        if (options.frontMatter !== false) {
+          const parsed = matter(content);
+          frontMatter = parsed.data;
+          markdown = parsed.content;
+        }
+        const rendered = marked.parse(markdown);
+        const html = typeof rendered === "string" ? rendered : await rendered;
+        files.push({
+          path: file,
+          frontMatter,
+          markdown,
+          html
+        });
+      }
+      context.logger.info(`Found ${files.length.toString()} markdown files`);
+      context.cache.set("markdown:files", files);
+    },
+    afterExtract(docs) {
+      const guideDocs = files.map((file) => {
+        const fileName = path10.basename(file.path, path10.extname(file.path));
+        const title = typeof file.frontMatter.title === "string" ? file.frontMatter.title : fileName;
+        const description = typeof file.frontMatter.description === "string" ? file.frontMatter.description : "";
+        return {
+          id: `guide:${file.path}`,
+          name: title,
+          kind: "guide",
+          fileName: file.path,
+          source: { file: file.path, line: 1, column: 0 },
+          position: { line: 1, column: 0 },
+          signature: "",
+          documentation: {
+            summary: description,
+            tags: []
+          },
+          metadata: {
+            markdown: file.markdown,
+            html: file.html,
+            frontMatter: file.frontMatter
+          }
+        };
+      });
+      return [...docs, ...guideDocs];
+    }
+  };
+}
+export {
+  markdownPlugin as default,
+  markdownPlugin
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@opensyntaxhq/autodocs-plugin-markdown",
+  "version": "1.0.0",
+  "license": "Apache-2.0",
+  "description": "Markdown guide plugin for Autodocs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OpenSyntaxHQ/autodocs.git",
+    "directory": "packages/plugins/markdown"
+  },
+  "bugs": {
+    "url": "https://github.com/OpenSyntaxHQ/autodocs/issues"
+  },
+  "homepage": "https://github.com/OpenSyntaxHQ/autodocs",
+  "keywords": [
+    "autodocs",
+    "plugin",
+    "markdown",
+    "documentation"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "lint": "eslint .",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "glob": "^13.0.1",
+    "gray-matter": "^4.0.3",
+    "marked": "^17.0.1"
+  },
+  "peerDependencies": {
+    "@opensyntaxhq/autodocs-core": "^1.0.0"
+  },
+  "devDependencies": {
+    "@opensyntaxhq/autodocs-core": "^1.0.0",
+    "@types/node": "^22.0.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.9.0"
+  }
+}