# npm
npm install textlint-plugin-typst
# Yarn
yarn add textlint-plugin-typst
# pnpm
pnpm add textlint-plugin-typst
# Bun
bun add textlint-plugin-typst
{
"plugins": {
"typst": true
}
}
extensions
:string[]
- Additional file extensions for Typst
This plugin supports the syntax of Typst v0.13.1.
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 | π« | π« | |
Reference | π« | π« | |
Heading | Header | β | π« |
Bullet list | List / ListItem | β | π« |
Numbered list | List / ListItem | β | π« |
Term list | π« | π« | |
Math | Code / CodeBlock | β | π« |
Line break | Break | β | π« |
Smart quote | π« | π« | |
Symbol shorthand | π« | π« | |
Code expression | π« | π« | |
Character escape | π« | π« | |
Comment | Comment | β | π« |
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.
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