@dogsbay/format-obsidian 0.2.0-beta.13 → 0.2.0-beta.130

package/dist/serialize.d.ts

@@ -6,8 +6,26 @@
  * that have no native Obsidian equivalent.
  */
 import type { TreeNode } from "@dogsbay/types";
+/**
+ * Sanitize a slug into a valid Obsidian BLOCK IDENTIFIER.
+ *
+ * Obsidian block ids accept only letters, numbers and dashes. Anything else
+ * means the `^id` is not parsed as a block id at all — it renders as literal
+ * text in BOTH edit and reading view, and any `#^id` link pointing at it is
+ * dead.
+ *
+ * This is not a corner case: AsciiDoc ids join a module and its context with
+ * an underscore (`additional-resources_welcome-index`), so a real OpenShift
+ * vault had 21,509 unusable anchors across 82% of its notes, and 2,333 of its
+ * cross-references (21%) resolved to nothing. The visible tell is that a
+ * dash-only id like `^welcome-index` superscripts and hides correctly while
+ * its underscore sibling does not.
+ *
+ * MUST be applied to the anchor and to every link that targets it, or the two
+ * stop agreeing — which is worse than leaving both broken.
+ */
+export declare function obsidianBlockId(slug: string): string;
 /**
  * Convert TreeNode[] to Obsidian-flavored Markdown.
  */
 export declare function treeToObsidian(nodes: TreeNode[]): string;
-//# sourceMappingURL=serialize.d.ts.map