polytypo 1.6.2 → 1.7.0

package/README.md

@@ -99,6 +99,33 @@ even four spaces is prose and a brace in it is a JSX expression: the same sample
 `POLYTYPO_MALFORMED_INPUT` instead. A fence or a code span is the one marker that means _code_ in
 both dialects.
 
+Frontmatter is skipped whole by default, delimiters included — it is a machine-read block, and
+`fr` would put a narrow no-break space in front of the colon of every field in it. On a site whose
+frontmatter carries the headline that leaves the most visible string on the page untouched, so name
+the keys you want processed:
+
+```ts
+import { transform } from "polytypo/markdown";
+
+transform(
+  `---\ntitle: He said "hello" once\nslug: "he-said-hello"\n---\n\nThe body was typeset all along.\n`,
+  { locale: "en-US", dialect: "commonmark", frontmatterKeys: ["title"] },
+);
+// ---
+// title: He said “hello” once
+// slug: "he-said-hello"
+// ---
+//
+// The body was typeset all along.
+```
+
+Without the option nothing in the block changes, and a key you do not name never does. The block is
+read with the same scanner `yaml` mode uses, so it refuses the same constructs — a single-quoted
+scalar containing `''` among them, which is how an apostrophe is written inside single quotes, so
+`title: 'It''s a test'` comes back untouched. Double-quoted and plain scalars have no such limit.
+The block is also processed separately from the body, which shows up in exactly one place: an
+unbalanced quotation mark in `title` cannot pair with a mark in your first paragraph.
+
 `analyze()` runs the same pipeline and reports what it would do instead of doing it — one record
 per edit, each with the rule that made it and code-point offsets into the input you passed (into
 the **document**, in `html`, `markdown` and `yaml` mode, not into a span):

package/dist/{chunk-CW3GAIYQ.js → chunk-25XZKUNP.js}

@@ -5837,4 +5837,4 @@ export {
   runRules,
   runRulesRecording
 };
-//# sourceMappingURL=chunk-CW3GAIYQ.js.map
+//# sourceMappingURL=chunk-25XZKUNP.js.map