@theholocron/markdownlint-config 8.4.8

package/README.md

@@ -0,0 +1,25 @@
+# Markdownlint Config
+
+A [markdownlint configuration](https://github.com/DavidAnson/markdownlint) for consistent markdown documentation, compatible with `@theholocron/prettier-config`.
+
+## Installation
+
+```bash
+pnpm add -D @theholocron/markdownlint-config markdownlint
+```
+
+## Usage
+
+```js
+import config from "@theholocron/markdownlint-config";
+import { lint } from "markdownlint/promise";
+
+const results = await lint({ config, files: ["README.md"] });
+```
+
+## Rule choices
+
+- Starts from `markdownlint`'s own upstream `style/prettier` preset — every rule that would otherwise conflict with Prettier's markdown formatting (line length, emphasis/strong style, blank-line placement, indent width, hard tabs, trailing whitespace) is already off.
+- **Inline HTML allowed** (`no-inline-html` off) — badges, `<details>`, `<sub>` show up throughout this org's docs.
+- **No required leading H1** (`first-line-heading` off) — spec files and doc partials routinely open with something other than a top-level heading.
+- **Duplicate headings only flagged within the same nesting level** (`duplicate-heading: { siblings_only: true }`) — a repeated heading text at a different level (a common TOC/section-per-subsystem pattern) is allowed.

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import { Configuration } from "markdownlint";
+//#region index.d.ts
+/**
+ * @see https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+ *
+ * Org-specific additions on top of the upstream Prettier-compatibility
+ * preset, none of which that preset already covers:
+ *
+ * - `no-inline-html` (MD033): off. Badges, `<details>`/`<sub>`, and other
+ *   raw HTML show up throughout this org's READMEs and wiki docs — same
+ *   "advisory, not overly strict" stance `ALEX_CONFIG` takes.
+ * - `first-line-heading`/`first-line-h1` (MD041): off. Spec files
+ *   (`.notes/*.spec.md`) and doc partials routinely don't open with an H1
+ *   — frontmatter-style prose or a directive comment comes first instead.
+ * - `duplicate-heading` (MD024): `siblings_only: true`, not a blanket
+ *   disable — still catches a genuine duplicate at the same nesting level,
+ *   but allows the same heading text at different levels (a common
+ *   TOC/section-per-subsystem pattern in this org's longer docs).
+ */
+declare const config: Configuration;
+//#endregion
+export { config as default };

package/dist/index.js

@@ -0,0 +1,27 @@
+import prettierStyle from "markdownlint/style/prettier" with { type: "json" };
+//#region index.ts
+/**
+* @see https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+*
+* Org-specific additions on top of the upstream Prettier-compatibility
+* preset, none of which that preset already covers:
+*
+* - `no-inline-html` (MD033): off. Badges, `<details>`/`<sub>`, and other
+*   raw HTML show up throughout this org's READMEs and wiki docs — same
+*   "advisory, not overly strict" stance `ALEX_CONFIG` takes.
+* - `first-line-heading`/`first-line-h1` (MD041): off. Spec files
+*   (`.notes/*.spec.md`) and doc partials routinely don't open with an H1
+*   — frontmatter-style prose or a directive comment comes first instead.
+* - `duplicate-heading` (MD024): `siblings_only: true`, not a blanket
+*   disable — still catches a genuine duplicate at the same nesting level,
+*   but allows the same heading text at different levels (a common
+*   TOC/section-per-subsystem pattern in this org's longer docs).
+*/
+const config = {
+	...prettierStyle,
+	"no-inline-html": false,
+	"first-line-heading": false,
+	"duplicate-heading": { siblings_only: true }
+};
+//#endregion
+export { config as default };

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@theholocron/markdownlint-config",
+  "version": "8.4.8",
+  "description": "A markdownlint configuration for documentation in the Galaxy.",
+  "keywords": [
+    "markdownlint",
+    "markdown",
+    "linting",
+    "config",
+    "theholocron"
+  ],
+  "homepage": "https://github.com/theholocron/configs/tree/main/packages/markdownlint-config#readme",
+  "bugs": "https://github.com/theholocron/configs/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theholocron/configs.git"
+  },
+  "license": "GPL-3.0",
+  "author": "Newton Koumantzelis",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "delivery.build": "tsdown",
+    "sourceQuality.staticAnalysis": "holocron run sourceQuality.staticAnalysis --",
+    "test:watch": "vitest",
+    "verification.typeSafety": "holocron run verification.typeSafety --",
+    "verification.unitTests": "holocron run verification.unitTests --"
+  },
+  "devDependencies": {
+    "@theholocron/cli": "catalog:holocron",
+    "@theholocron/tsconfig": "workspace:*",
+    "@theholocron/vitest-config": "workspace:*",
+    "@vitest/coverage-v8": "catalog:",
+    "tsdown": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  },
+  "peerDependencies": {
+    "markdownlint": "^0.41"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "releases": "https://github.com/theholocron/configs/releases",
+  "wiki": "https://github.com/theholocron/configs/wiki"
+}