punctilio 1.7.11 → 1.7.13
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 +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
[](https://github.com/alexander-turner/punctilio/actions/workflows/lint.yml)
|
|
5
5
|
[](https://github.com/alexander-turner/punctilio)
|
|
6
6
|
|
|
7
|
-
Pretty good at making your text pretty. The most feature-complete and reliable English typography package
|
|
7
|
+
Pretty good at making your text pretty. The most feature-complete and reliable English typography package. `punctilio` transforms plain ASCII into typographically correct Unicode, even across HTML element boundaries.
|
|
8
8
|
|
|
9
|
-
**Smart quotes** · **Em/en dashes** · **Ellipses** · **Math symbols** · **Legal symbols** · **Arrows** · **Primes** · **Fractions** · **Superscripts** · **Ligatures** · **Non-breaking spaces** · **HTML-aware** · **Bri
|
|
9
|
+
**Smart quotes** · **Em/en dashes** · **Ellipses** · **Math symbols** · **Legal symbols** · **Arrows** · **Primes** · **Fractions** · **Superscripts** · **Ligatures** · **Non-breaking spaces** · **HTML-aware** · **Bri’ish localisation support**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
12
|
import { transform } from 'punctilio'
|
|
@@ -115,7 +115,7 @@ For manual DOM walking or custom transforms, use `transformElement` from `puncti
|
|
|
115
115
|
|
|
116
116
|
## Options
|
|
117
117
|
|
|
118
|
-
`punctilio` doesn
|
|
118
|
+
`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. Furthermore, `ligatures = true` can change the meaning of text by collapsing question and exclamation marks. Non-breaking spaces are also opt-in since they alter whitespace throughout the text.
|
|
119
119
|
|
|
120
120
|
```typescript
|
|
121
121
|
transform(text, {
|