punctilio 0.4.14 → 0.4.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -75,14 +75,14 @@ import { transform, DEFAULT_SEPARATOR } from 'punctilio'
|
|
|
75
75
|
|
|
76
76
|
transform(`"Wait${DEFAULT_SEPARATOR}"`)
|
|
77
77
|
// → `“Wait”${DEFAULT_SEPARATOR}`
|
|
78
|
-
// The separator doesn
|
|
78
|
+
// The separator doesn’t block the information that this should be an end-quote!
|
|
79
79
|
```
|
|
80
80
|
|
|
81
81
|
Your DOM walker tracks which text node each segment came from, inserts separators between them, transforms the combined string, then splits on separators to update each node. Use the `separator` option if `U+E000` conflicts with your content. For an example of how to integrate this functionality, see [my website’s code](https://github.com/alexander-turner/TurnTrout.com/blob/main/quartz/plugins/transformers/formatting_improvement_html.ts).
|
|
82
82
|
|
|
83
83
|
## Options
|
|
84
84
|
|
|
85
|
-
`punctilio` doesn’t enable all transformations by default. Fractions and degrees tend to match too aggressively (perfectly applying the degree transformation requires semantic meaning). Superscript letters and punctuation ligatures have spotty font support—this README’s font doesn’t even support the example superscript! Furthermore, `ligatures = true` can change the meaning of text by collapsing question and exclamation marks.
|
|
85
|
+
`punctilio` doesn’t enable all transformations by default. Fractions and degrees tend to match too aggressively (perfectly applying the degree transformation requires semantic meaning). Superscript letters and punctuation ligatures have spotty font support—on GitHub, this README’s font doesn’t even support the example superscript! Furthermore, `ligatures = true` can change the meaning of text by collapsing question and exclamation marks.
|
|
86
86
|
|
|
87
87
|
```typescript
|
|
88
88
|
transform(text, {
|