@cssdoc/config 0.4.1 → 0.5.0

package/cssdoc.schema.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://cssdoc.dev/cssdoc.schema.json",
   "title": "cssdoc.json",
-  "description": "Configuration for @cssdoc/core: custom tags and inherited configs.",
+  "description": "Configuration for cssdoc: custom tags, lint rules, and markdown render options.",
   "type": "object",
   "additionalProperties": false,
   "properties": {
@@ -145,6 +145,48 @@
       "items": {
         "type": "string"
       }
+    },
+    "render": {
+      "description": "Markdown render options for the CSS API pages (used by @cssdoc/markdown and @cssdoc/typedoc). Explicit emitter options still override these.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "sectionOrder": {
+          "description": "Order (and inclusion) of the reorderable ## sections on a record page; omitted keys are dropped.",
+          "type": "array",
+          "items": {
+            "enum": [
+              "demo",
+              "examples",
+              "usage",
+              "modifiers",
+              "parts",
+              "shadowParts",
+              "states",
+              "slots",
+              "structure",
+              "cssProperties",
+              "functions",
+              "animations",
+              "layers",
+              "conditions",
+              "tokensConsumed",
+              "compat",
+              "accessibility",
+              "related",
+              "see"
+            ]
+          }
+        },
+        "headingPrefix": {
+          "description": "Prefix for each record page title, e.g. \"CSS:\".",
+          "type": "string"
+        },
+        "baseHref": {
+          "description": "Base href for @related cross-links and the sidebar/index links.",
+          "type": "string"
+        }
+      }
     }
   }
 }

package/dist/index.d.mts

@@ -8,6 +8,16 @@ interface NamingOverride {
   component?: string;
   part?: string;
 }
+/**
+ * The `render` block: markdown render options for the CSS API pages, as spelled in `cssdoc.json`.
+ * `sectionOrder` items are the emitter's section keys (typed loosely here to keep `@cssdoc/config`
+ * independent of `@cssdoc/markdown`; the emitter validates/uses them).
+ */
+interface RenderConfig {
+  sectionOrder?: readonly string[];
+  headingPrefix?: string;
+  baseHref?: string;
+}
 /**
  * The conventional file names loaders look for, in preference order. Both are parsed the same way
  * (JSON with comments); `.jsonc` just makes the comments explicit.
@@ -48,6 +58,12 @@ declare class CssDocConfigFile {
    * chain. Pass to `lintModel` in `@cssdoc/providers`.
    */
   readonly structureIgnore: readonly string[];
+  /**
+   * Markdown render options (`sectionOrder`/`headingPrefix`/`baseHref`), merged across the `extends`
+   * chain (this file wins). The emitter (`@cssdoc/markdown`/`@cssdoc/typedoc`) reads these as defaults;
+   * explicit emitter options still override. Not part of the parser `CssDocConfiguration`.
+   */
+  readonly render: Readonly<RenderConfig>;
   private constructor();
   /** Whether this file — or any file it extends — reported an error. */
   get hasErrors(): boolean;
@@ -97,7 +113,7 @@ declare const cssDocSchema: {
   readonly $schema: "http://json-schema.org/draft-07/schema#";
   readonly $id: "https://cssdoc.dev/cssdoc.schema.json";
   readonly title: "cssdoc.json";
-  readonly description: "Configuration for @cssdoc/core: custom tags and inherited configs.";
+  readonly description: "Configuration for cssdoc: custom tags, lint rules, and markdown render options.";
   readonly type: "object";
   readonly additionalProperties: false;
   readonly properties: {
@@ -232,6 +248,28 @@ declare const cssDocSchema: {
         readonly type: "string";
       };
     };
+    readonly render: {
+      readonly description: "Markdown render options for the CSS API pages (used by @cssdoc/markdown and @cssdoc/typedoc). Explicit emitter options still override these.";
+      readonly type: "object";
+      readonly additionalProperties: false;
+      readonly properties: {
+        readonly sectionOrder: {
+          readonly description: "Order (and inclusion) of the reorderable ## sections on a record page; omitted keys are dropped.";
+          readonly type: "array";
+          readonly items: {
+            readonly enum: readonly ["demo", "examples", "usage", "modifiers", "parts", "shadowParts", "states", "slots", "structure", "cssProperties", "functions", "animations", "layers", "conditions", "tokensConsumed", "compat", "accessibility", "related", "see"];
+          };
+        };
+        readonly headingPrefix: {
+          readonly description: "Prefix for each record page title, e.g. \"CSS:\".";
+          readonly type: "string";
+        };
+        readonly baseHref: {
+          readonly description: "Base href for @related cross-links and the sidebar/index links.";
+          readonly type: "string";
+        };
+      };
+    };
   };
 };
 //#endregion

package/dist/index.mjs

@@ -17,7 +17,7 @@ const cssDocSchema = {
 	$schema: "http://json-schema.org/draft-07/schema#",
 	$id: "https://cssdoc.dev/cssdoc.schema.json",
 	title: "cssdoc.json",
-	description: "Configuration for @cssdoc/core: custom tags and inherited configs.",
+	description: "Configuration for cssdoc: custom tags, lint rules, and markdown render options.",
 	type: "object",
 	additionalProperties: false,
 	properties: {
@@ -129,6 +129,46 @@ const cssDocSchema = {
 			description: "Class names to exempt from the structure-unknown-selector rule — legitimately-external classes (utilities, cross-component refs) referenced in @structure. Literal names or simple globs where * matches any run of characters (e.g. util-*).",
 			type: "array",
 			items: { type: "string" }
+		},
+		render: {
+			description: "Markdown render options for the CSS API pages (used by @cssdoc/markdown and @cssdoc/typedoc). Explicit emitter options still override these.",
+			type: "object",
+			additionalProperties: false,
+			properties: {
+				sectionOrder: {
+					description: "Order (and inclusion) of the reorderable ## sections on a record page; omitted keys are dropped.",
+					type: "array",
+					items: { enum: [
+						"demo",
+						"examples",
+						"usage",
+						"modifiers",
+						"parts",
+						"shadowParts",
+						"states",
+						"slots",
+						"structure",
+						"cssProperties",
+						"functions",
+						"animations",
+						"layers",
+						"conditions",
+						"tokensConsumed",
+						"compat",
+						"accessibility",
+						"related",
+						"see"
+					] }
+				},
+				headingPrefix: {
+					description: "Prefix for each record page title, e.g. \"CSS:\".",
+					type: "string"
+				},
+				baseHref: {
+					description: "Base href for @related cross-links and the sidebar/index links.",
+					type: "string"
+				}
+			}
 		}
 	}
 };
@@ -184,6 +224,12 @@ var CssDocConfigFile = class CssDocConfigFile {
 	* chain. Pass to `lintModel` in `@cssdoc/providers`.
 	*/
 	structureIgnore;
+	/**
+	* Markdown render options (`sectionOrder`/`headingPrefix`/`baseHref`), merged across the `extends`
+	* chain (this file wins). The emitter (`@cssdoc/markdown`/`@cssdoc/typedoc`) reads these as defaults;
+	* explicit emitter options still override. Not part of the parser `CssDocConfiguration`.
+	*/
+	render;
 	constructor(init) {
 		this.filePath = init.filePath;
 		this.fileNotFound = init.fileNotFound;
@@ -195,17 +241,21 @@ var CssDocConfigFile = class CssDocConfigFile {
 		this.modifierConvention = init.modifierConvention;
 		const severities = {};
 		const naming = {};
+		const render = {};
 		const structureIgnore = /* @__PURE__ */ new Set();
 		for (const extended of init.extendsFiles) {
 			Object.assign(severities, extended.ruleSeverities);
 			Object.assign(naming, extended.naming);
+			Object.assign(render, extended.render);
 			for (const g of extended.structureIgnore) structureIgnore.add(g);
 		}
 		Object.assign(severities, init.rules);
 		Object.assign(naming, init.naming);
+		Object.assign(render, init.render);
 		for (const g of init.structureIgnore) structureIgnore.add(g);
 		this.ruleSeverities = severities;
 		this.naming = naming;
+		this.render = render;
 		this.structureIgnore = [...structureIgnore];
 	}
 	/** Whether this file — or any file it extends — reported an error. */
@@ -279,7 +329,8 @@ var CssDocConfigFile = class CssDocConfigFile {
 			extendsFiles: [],
 			rules: {},
 			naming: {},
-			structureIgnore: []
+			structureIgnore: [],
+			render: {}
 		});
 	}
 	static _loadFile(filePath, visited) {
@@ -294,7 +345,8 @@ var CssDocConfigFile = class CssDocConfigFile {
 			extendsFiles: [],
 			rules: {},
 			naming: {},
-			structureIgnore: []
+			structureIgnore: [],
+			render: {}
 		});
 		if (visited.has(filePath)) {
 			messages.push("Circular extends reference; skipped.");
@@ -342,7 +394,8 @@ var CssDocConfigFile = class CssDocConfigFile {
 			modifierConvention: raw.modifierConvention,
 			rules: raw.rules ?? {},
 			naming: raw.naming ?? {},
-			structureIgnore: raw.structureIgnore ?? []
+			structureIgnore: raw.structureIgnore ?? [],
+			render: raw.render ?? {}
 		});
 	}
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cssdoc/config",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Load a cssdoc.json configuration file (custom tags, extends) into an @cssdoc/core CssDocConfiguration — TSDoc-config, for CSS.",
   "keywords": [
     "config",
@@ -32,7 +32,7 @@
   "dependencies": {
     "ajv": "^8.20.0",
     "jsonc-parser": "^3.3.1",
-    "@cssdoc/core": "0.4.1"
+    "@cssdoc/core": "0.5.0"
   },
   "devDependencies": {
     "@types/node": "^24.13.3",