textlint-plugin-typst
March 4, 2026 · View on GitHub
Installation
# npm
npm install textlint-plugin-typst
# Yarn
yarn add textlint-plugin-typst
# pnpm
pnpm add textlint-plugin-typst
# Bun
bun add textlint-plugin-typst
Usage
{
"plugins": {
"typst": true
}
}
Options
extensions:string[]- Additional file extensions for Typst
Syntax support
This plugin supports the syntax of Typst v0.14.2.
Legend for syntax support:
- ✅: Supported
- 🚫: Not in progress
- ⌛️: In progress
- ⚠️: Partially supported (with some caveats)
| Typst | textlint | Markup | Function |
|---|---|---|---|
| Paragraph break | Paragraph | ✅ | 🚫 |
| Strong emphasis | Strong | ✅ | 🚫 |
| Emphasis | Emphasis | ✅ | 🚫 |
| Raw text | Code / CodeBlock | ✅ | 🚫 |
| Link | Link | ✅ | 🚫 |
| Label | Code | ✅ | 🚫 |
| Reference | Code | ✅ | 🚫 |
| Heading | Header | ✅ | 🚫 |
| Bullet list | List / ListItem | ✅ | 🚫 |
| Numbered list | List / ListItem | ✅ | 🚫 |
| Term list | List / ListItem | ⚠️ | 🚫 |
| Math | Code / CodeBlock | ✅ | 🚫 |
| Line break | Break | ✅ | 🚫 |
| Smart quote | Str | ✅ | 🚫 |
| Symbol shorthand | Code | ✅ | 🚫 |
| Code expression | ✅ | ✅ | |
| Character escape | Code | ✅ | 🚫 |
| Comment | Comment | ✅ | 🚫 |
Examples
textlint-filter-rule-comments
Example of how to use textlint-filter-rule-comments is shown below.
This is error text.
/* textlint-disable */
This is ignored text by rule.
Disables all rules between comments
/* textlint-enable */
This is error text.
Also, you can use single-line comments.
This is error text.
// textlint-disable
This is ignored text by rule.
Disables all rules between comments
// textlint-enable
This is error text.
Contributing
This project is still under development, so please feel free to contribute!
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D