@graphql-markdown/docusaurus 1.28.0 → 1.29.0

package/dist/mdx/category.d.ts

@@ -0,0 +1,2 @@
+import type { GenerateIndexMetafileType } from "@graphql-markdown/types";
+export declare const generateIndexMetafile: GenerateIndexMetafileType;

package/dist/mdx/category.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateIndexMetafile = void 0;
+const node_path_1 = require("node:path");
+const utils_1 = require("@graphql-markdown/utils");
+const CATEGORY_YAML = "_category_.yml";
+var SidebarPosition;
+(function (SidebarPosition) {
+    SidebarPosition[SidebarPosition["FIRST"] = 1] = "FIRST";
+    SidebarPosition[SidebarPosition["LAST"] = 999] = "LAST";
+})(SidebarPosition || (SidebarPosition = {}));
+const generateIndexMetafile = async (dirPath, category, options) => {
+    const filePath = (0, node_path_1.join)(dirPath, CATEGORY_YAML);
+    if (await (0, utils_1.fileExists)(filePath)) {
+        return;
+    }
+    const label = (0, utils_1.startCase)(category);
+    const link = options?.index !== true
+        ? "null"
+        : `\n  type: generated-index\n  title: '${label} overview'`;
+    const className = typeof options?.styleClass === "string"
+        ? `className: ${options.styleClass}\n`
+        : "";
+    const position = typeof options?.sidebarPosition === "number"
+        ? options.sidebarPosition
+        : SidebarPosition.FIRST;
+    const content = `label: ${label}\nposition: ${position}\n${className}link: ${link}\ncollapsible: ${options?.collapsible ?? true}\ncollapsed: ${options?.collapsed ?? true}\n`;
+    await (0, utils_1.ensureDir)(dirPath);
+    await (0, utils_1.saveFile)(filePath, content);
+};
+exports.generateIndexMetafile = generateIndexMetafile;

package/dist/mdx/index.d.ts

@@ -1,12 +1,10 @@
-import type { AdmonitionType, Badge, Maybe, MDXString, MetaOptions, TypeLink } from "@graphql-markdown/types";
+import type { AdmonitionType, Badge, CollapsibleOption, Maybe, MDXString, MetaOptions, TypeLink } from "@graphql-markdown/types";
 export { mdxDeclaration } from "./components";
+export { generateIndexMetafile } from "./category";
 export declare const formatMDXBadge: ({ text, classname }: Badge) => MDXString;
 export declare const formatMDXAdmonition: ({ text, title, type }: AdmonitionType, meta: Maybe<MetaOptions>) => MDXString;
 export declare const formatMDXBullet: (text?: string) => MDXString;
-export declare const formatMDXDetails: ({ dataOpen, dataClose, }: {
-    dataOpen: Maybe<string>;
-    dataClose: Maybe<string>;
-}) => MDXString;
+export declare const formatMDXDetails: ({ dataOpen, dataClose, }: CollapsibleOption) => MDXString;
 export declare const formatMDXSpecifiedByLink: (url: string) => MDXString;
 export declare const formatMDXNameEntity: (name: string, parentType?: Maybe<string>) => MDXString;
 export declare const formatMDXLink: ({ text, url }: TypeLink) => TypeLink;

package/dist/mdx/index.js

@@ -1,13 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatMDXLink = exports.formatMDXNameEntity = exports.formatMDXSpecifiedByLink = exports.formatMDXDetails = exports.formatMDXBullet = exports.formatMDXAdmonition = exports.formatMDXBadge = exports.mdxDeclaration = void 0;
+exports.formatMDXLink = exports.formatMDXNameEntity = exports.formatMDXSpecifiedByLink = exports.formatMDXDetails = exports.formatMDXBullet = exports.formatMDXAdmonition = exports.formatMDXBadge = exports.generateIndexMetafile = exports.mdxDeclaration = void 0;
 const MARKDOWN_EOL = "\n";
 const MARKDOWN_EOP = `${MARKDOWN_EOL.repeat(2)}`;
 const LINK_MDX_EXTENSION = ".mdx";
+const DEFAULT_CSS_CLASSNAME = "badge--secondary";
 var components_1 = require("./components");
 Object.defineProperty(exports, "mdxDeclaration", { enumerable: true, get: function () { return components_1.mdxDeclaration; } });
+var category_1 = require("./category");
+Object.defineProperty(exports, "generateIndexMetafile", { enumerable: true, get: function () { return category_1.generateIndexMetafile; } });
 const formatMDXBadge = ({ text, classname }) => {
-    return `<Badge class="badge ${classname}" text="${text}"/>`;
+    const style = typeof classname === "string" ? `badge--${classname.toLowerCase()}` : "";
+    return `<Badge class="badge ${DEFAULT_CSS_CLASSNAME} ${style}" text="${text}"/>`;
 };
 exports.formatMDXBadge = formatMDXBadge;
 const formatMDXAdmonition = ({ text, title, type }, meta) => {

package/package.json

@@ -5,7 +5,7 @@
   "bugs": {
     "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
   },
-  "version": "1.28.0",
+  "version": "1.29.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -65,12 +65,14 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@graphql-markdown/cli": "^0.2.0",
+    "@graphql-markdown/cli": "^0.3.0",
+    "@graphql-markdown/logger": "^1.0.5",
+    "@graphql-markdown/utils": "^1.8.0",
     "@docusaurus/utils": ">=3.2.0"
   },
   "devDependencies": {
     "@docusaurus/types": "^3.7.0",
-    "@graphql-markdown/types": "^1.6.0"
+    "@graphql-markdown/types": "^1.7.0"
   },
   "peerDependencies": {
     "@docusaurus/logger": "*"