{"id":20901678,"url":"https://github.com/textlint/textlint-plugin-typst","last_synced_at":"2025-05-13T03:30:55.760Z","repository":{"id":257816609,"uuid":"766407193","full_name":"textlint/textlint-plugin-typst","owner":"textlint","description":"textlint plugin to lint Typst","archived":false,"fork":false,"pushed_at":"2025-03-25T18:29:13.000Z","size":255,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-28T10:55:09.685Z","etag":null,"topics":["lint","plugin","textlint","textlintplugin","typst"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/textlint-plugin-typst","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/textlint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"azu"}},"created_at":"2024-03-03T07:08:52.000Z","updated_at":"2025-03-25T18:23:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"adeceaa1-0295-4081-829d-2d4640b39d9f","html_url":"https://github.com/textlint/textlint-plugin-typst","commit_stats":null,"previous_names":["3w36zj6/textlint-plugin-typst","textlint/textlint-plugin-typst"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-plugin-typst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-plugin-typst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-plugin-typst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-plugin-typst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textlint","download_url":"https://codeload.github.com/textlint/textlint-plugin-typst/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253867392,"owners_count":21976217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lint","plugin","textlint","textlintplugin","typst"],"created_at":"2024-11-18T11:36:35.472Z","updated_at":"2025-05-13T03:30:55.748Z","avatar_url":"https://github.com/textlint.png","language":"TypeScript","funding_links":["https://github.com/sponsors/azu"],"categories":["Integrations \u0026 Tools"],"sub_categories":["CLI Tools"],"readme":"# textlint-plugin-typst\n\n[![NPM Version](https://img.shields.io/npm/v/textlint-plugin-typst)](https://www.npmjs.com/package/textlint-plugin-typst?activeTab=versions)\n[![NPM Downloads](https://img.shields.io/npm/d18m/textlint-plugin-typst)](https://www.npmjs.com/package/textlint-plugin-typst)\n[![NPM License](https://img.shields.io/npm/l/textlint-plugin-typst)](https://github.com/3w36zj6/textlint-plugin-typst/blob/HEAD/LICENSE)\n[![CI](https://github.com/3w36zj6/textlint-plugin-typst/actions/workflows/ci.yaml/badge.svg?branch=main\u0026event=push)](https://github.com/3w36zj6/textlint-plugin-typst/actions/workflows/ci.yaml)\n\n[textlint](https://github.com/textlint/textlint) plugin to lint [Typst](https://typst.app/)\n\n## Installation\n\n```sh\n# npm\nnpm install textlint-plugin-typst\n\n# Yarn\nyarn add textlint-plugin-typst\n\n# pnpm\npnpm add textlint-plugin-typst\n\n# Bun\nbun add textlint-plugin-typst\n```\n\n## Usage\n\n```json\n{\n  \"plugins\": {\n    \"typst\": true\n  }\n}\n```\n\n## Options\n\n- `extensions`: `string[]`\n  - Additional file extensions for Typst\n\n## Syntax support\n\nThis plugin supports the syntax of Typst [v0.13.0](https://github.com/typst/typst/releases/tag/v0.13.0).\n\nLegend for syntax support:\n\n- ✅: Supported\n- 🚫: Not in progress\n- ⌛️: In progress\n- ⚠️: Partially supported (with some caveats)\n\n| Typst | textlint | Markup | Function |\n| --- | --- | --- | --- |\n| Paragraph break | Paragraph | ✅ | 🚫 |\n| Strong emphasis | Strong | ✅ | 🚫 |\n| Emphasis | Emphasis | ✅ | 🚫 |\n| Raw text | Code / CodeBlock | ✅ | 🚫 |\n| Link | Link | ✅ | 🚫 |\n| Label | | 🚫 | 🚫 |\n| Reference | | 🚫 | 🚫 |\n| Heading | Header | ✅ | 🚫 |\n| Bullet list | List / ListItem | 🚫 | 🚫 |\n| Numbered list | List / ListItem | 🚫 | 🚫 |\n| Term list | | 🚫 | 🚫 |\n| Math | | 🚫 | 🚫 |\n| Line break | Break | ✅ | 🚫 |\n| Smart quote | | 🚫 | 🚫 |\n| Symbol shorthand | | 🚫 | 🚫 |\n| Code expression | | 🚫 | 🚫 |\n| Character escape | | 🚫 | 🚫 |\n| Comment | Comment | ✅ | 🚫 |\n\n## Examples\n\n### textlint-filter-rule-comments\n\nExample of how to use [textlint-filter-rule-comments](https://www.npmjs.com/package/textlint-filter-rule-comments) is shown below.\n\n```typst\nThis is error text.\n\n/* textlint-disable */\n\nThis is ignored text by rule.\nDisables all rules between comments\n\n/* textlint-enable */\n\nThis is error text.\n```\n\nAlso, you can use single-line comments.\n\n```typst\nThis is error text.\n\n// textlint-disable\n\nThis is ignored text by rule.\nDisables all rules between comments\n\n// textlint-enable\n\nThis is error text.\n```\n\n## Contributing\n\nThis project is still under development, so please feel free to contribute!\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## Maintainers\n\n- [@3w36zj6](https://github.com/3w36zj6)\n\n## License\n\n[MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Ftextlint-plugin-typst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextlint%2Ftextlint-plugin-typst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Ftextlint-plugin-typst/lists"}