33 lines
1.6 KiB
TypeScript
33 lines
1.6 KiB
TypeScript
|
/**
|
||
|
|
* Check whether to encode (as a character reference) the characters
|
||
|
|
* surrounding an attention run.
|
||
|
|
*
|
||
|
|
* Which characters are around an attention run influence whether it works or
|
||
|
|
* not.
|
||
|
|
*
|
||
|
|
* See <https://github.com/orgs/syntax-tree/discussions/60> for more info.
|
||
|
|
* See this markdown in a particular renderer to see what works:
|
||
|
|
*
|
||
|
|
* ```markdown
|
||
|
|
* | | A (letter inside) | B (punctuation inside) | C (whitespace inside) | D (nothing inside) |
|
||
|
|
* | ----------------------- | ----------------- | ---------------------- | --------------------- | ------------------ |
|
||
|
|
* | 1 (letter outside) | x*y*z | x*.*z | x* *z | x**z |
|
||
|
|
* | 2 (punctuation outside) | .*y*. | .*.*. | .* *. | .**. |
|
||
|
|
* | 3 (whitespace outside) | x *y* z | x *.* z | x * * z | x ** z |
|
||
|
|
* | 4 (nothing outside) | *x* | *.* | * * | ** |
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @param {number} outside
|
||
|
|
* Code point on the outer side of the run.
|
||
|
|
* @param {number} inside
|
||
|
|
* Code point on the inner side of the run.
|
||
|
|
* @param {'*' | '_'} marker
|
||
|
|
* Marker of the run.
|
||
|
|
* Underscores are handled more strictly (they form less often) than
|
||
|
|
* asterisks.
|
||
|
|
* @returns {EncodeSides}
|
||
|
|
* Whether to encode characters.
|
||
|
|
*/
|
||
|
|
export function encodeInfo(outside: number, inside: number, marker: "*" | "_"): EncodeSides;
|
||
|
|
import type { EncodeSides } from '../types.js';
|
||
|
|
//# sourceMappingURL=encode-info.d.ts.map
|