@vellum-docs/profile-markdown 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,15 @@
+import { RenderContext, RendererProfile, Symbol, TypeString } from "@vellum-docs/core";
+
+//#region src/index.d.ts
+declare class MarkdownProfile implements RendererProfile {
+  readonly name = "markdown";
+  readonly targetExtensions: readonly [".md", ".mdx"];
+  typeRef(sym: Symbol, _ctx: RenderContext): string;
+  signature(sym: Symbol, _ctx: RenderContext): string;
+  typeString(ts: TypeString, _ctx: RenderContext): string;
+  typeCard(sym: Symbol, ctx: RenderContext): string;
+  link(sym: Symbol, _ctx: RenderContext): string;
+}
+//#endregion
+export { MarkdownProfile };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;cAaa,eAAA,YAA2B,eAAA;EAAA,SAC7B,IAAA;EAAA,SACA,gBAAA;EAET,OAAA,CAAQ,GAAA,EAAK,MAAA,EAAQ,IAAA,EAAM,aAAA;EAK3B,SAAA,CAAU,GAAA,EAAK,MAAA,EAAQ,IAAA,EAAM,aAAA;EAI7B,UAAA,CAAW,EAAA,EAAI,UAAA,EAAY,IAAA,EAAM,aAAA;EAIjC,QAAA,CAAS,GAAA,EAAK,MAAA,EAAQ,GAAA,EAAK,aAAA;EAc3B,IAAA,CAAK,GAAA,EAAK,MAAA,EAAQ,IAAA,EAAM,aAAA;AAAA"}

package/dist/index.mjs

@@ -0,0 +1,34 @@
+//#region src/index.ts
+const RE_TRAILING_WHITESPACE = /\s*$/;
+function codeFence(lang, body) {
+	return `\`\`\`${lang}\n${body.replace(RE_TRAILING_WHITESPACE, "")}\n\`\`\``;
+}
+var MarkdownProfile = class {
+	name = "markdown";
+	targetExtensions = [".md", ".mdx"];
+	typeRef(sym, _ctx) {
+		return `\`${sym.name}\``;
+	}
+	signature(sym, _ctx) {
+		return codeFence("ts", sym.signature);
+	}
+	typeString(ts, _ctx) {
+		return `\`${ts.text}\``;
+	}
+	typeCard(sym, ctx) {
+		const parts = [];
+		parts.push(`### ${sym.name}`);
+		if (sym.doc.summary) parts.push(sym.doc.summary);
+		parts.push(this.signature(sym, ctx));
+		if (sym.doc.description) parts.push(sym.doc.description);
+		for (const ex of sym.doc.examples) parts.push(codeFence(ex.lang || "ts", ex.code));
+		return parts.join("\n\n");
+	}
+	link(sym, _ctx) {
+		return `\`${sym.name}\``;
+	}
+};
+//#endregion
+export { MarkdownProfile };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type {\n  RenderContext,\n  RendererProfile,\n  Symbol,\n  TypeString,\n} from '@vellum-docs/core'\n\nconst RE_TRAILING_WHITESPACE = /\\s*$/\n\nfunction codeFence(lang: string, body: string): string {\n  return `\\`\\`\\`${lang}\\n${body.replace(RE_TRAILING_WHITESPACE, '')}\\n\\`\\`\\``\n}\n\nexport class MarkdownProfile implements RendererProfile {\n  readonly name = 'markdown'\n  readonly targetExtensions = ['.md', '.mdx'] as const\n\n  typeRef(sym: Symbol, _ctx: RenderContext): string {\n    // Plain markdown has no hover — just render the name as inline code.\n    return `\\`${sym.name}\\``\n  }\n\n  signature(sym: Symbol, _ctx: RenderContext): string {\n    return codeFence('ts', sym.signature)\n  }\n\n  typeString(ts: TypeString, _ctx: RenderContext): string {\n    return `\\`${ts.text}\\``\n  }\n\n  typeCard(sym: Symbol, ctx: RenderContext): string {\n    const parts: string[] = []\n    parts.push(`### ${sym.name}`)\n    if (sym.doc.summary)\n      parts.push(sym.doc.summary)\n    parts.push(this.signature(sym, ctx))\n    if (sym.doc.description)\n      parts.push(sym.doc.description)\n    for (const ex of sym.doc.examples) {\n      parts.push(codeFence(ex.lang || 'ts', ex.code))\n    }\n    return parts.join('\\n\\n')\n  }\n\n  link(sym: Symbol, _ctx: RenderContext): string {\n    return `\\`${sym.name}\\``\n  }\n}\n"],"mappings":";AAOA,MAAM,yBAAyB;AAE/B,SAAS,UAAU,MAAc,MAAsB;AACrD,QAAO,SAAS,KAAK,IAAI,KAAK,QAAQ,wBAAwB,GAAG,CAAC;;AAGpE,IAAa,kBAAb,MAAwD;CACtD,OAAgB;CAChB,mBAA4B,CAAC,OAAO,OAAO;CAE3C,QAAQ,KAAa,MAA6B;AAEhD,SAAO,KAAK,IAAI,KAAK;;CAGvB,UAAU,KAAa,MAA6B;AAClD,SAAO,UAAU,MAAM,IAAI,UAAU;;CAGvC,WAAW,IAAgB,MAA6B;AACtD,SAAO,KAAK,GAAG,KAAK;;CAGtB,SAAS,KAAa,KAA4B;EAChD,MAAM,QAAkB,EAAE;AAC1B,QAAM,KAAK,OAAO,IAAI,OAAO;AAC7B,MAAI,IAAI,IAAI,QACV,OAAM,KAAK,IAAI,IAAI,QAAQ;AAC7B,QAAM,KAAK,KAAK,UAAU,KAAK,IAAI,CAAC;AACpC,MAAI,IAAI,IAAI,YACV,OAAM,KAAK,IAAI,IAAI,YAAY;AACjC,OAAK,MAAM,MAAM,IAAI,IAAI,SACvB,OAAM,KAAK,UAAU,GAAG,QAAQ,MAAM,GAAG,KAAK,CAAC;AAEjD,SAAO,MAAM,KAAK,OAAO;;CAG3B,KAAK,KAAa,MAA6B;AAC7C,SAAO,KAAK,IAAI,KAAK"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@vellum-docs/profile-markdown",
+  "type": "module",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/photon-hq/vellum.git",
+    "directory": "packages/profile-markdown"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@vellum-docs/core": "0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts --format esm --out-dir dist --dts",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}