{"id":15994234,"url":"https://github.com/textlint/textlint-plugin-mdx","last_synced_at":"2025-03-18T01:30:49.364Z","repository":{"id":230718158,"uuid":"779385013","full_name":"textlint/textlint-plugin-mdx","owner":"textlint","description":"textlint plugin to lint MDX","archived":false,"fork":false,"pushed_at":"2024-04-05T05:06:48.000Z","size":132,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-20T12:14:46.523Z","etag":null,"topics":["lint","mdx","plugin","textlint","textlintplugin"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/textlint-plugin-mdx","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":["3w36zj6"]}},"created_at":"2024-03-29T18:01:08.000Z","updated_at":"2024-09-27T15:18:51.000Z","dependencies_parsed_at":null,"dependency_job_id":"7649c9d6-0587-4169-ab27-b75ed9de14eb","html_url":"https://github.com/textlint/textlint-plugin-mdx","commit_stats":null,"previous_names":["3w36zj6/textlint-plugin-mdx"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-plugin-mdx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-plugin-mdx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-plugin-mdx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-plugin-mdx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textlint","download_url":"https://codeload.github.com/textlint/textlint-plugin-mdx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221704129,"owners_count":16866693,"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","mdx","plugin","textlint","textlintplugin"],"created_at":"2024-10-08T07:07:32.617Z","updated_at":"2024-10-27T16:27:02.521Z","avatar_url":"https://github.com/textlint.png","language":"TypeScript","funding_links":["https://github.com/sponsors/3w36zj6"],"categories":[],"sub_categories":[],"readme":"# textlint-plugin-mdx\n\n[![NPM Version](https://img.shields.io/npm/v/textlint-plugin-mdx)](https://www.npmjs.com/package/textlint-plugin-mdx?activeTab=versions)\n[![NPM Downloads](https://img.shields.io/npm/d18m/textlint-plugin-mdx)](https://www.npmjs.com/package/textlint-plugin-mdx)\n[![NPM License](https://img.shields.io/npm/l/textlint-plugin-mdx)](https://github.com/textlint/textlint-plugin-mdx/blob/HEAD/LICENSE)\n[![CI](https://github.com/textlint/textlint-plugin-mdx/actions/workflows/ci.yaml/badge.svg?branch=main\u0026event=push)](https://github.com/textlint/textlint-plugin-mdx/actions/workflows/ci.yaml)\n\n[textlint](https://github.com/textlint/textlint) plugin to lint [MDX](https://mdxjs.com/)\n\n## Installation\n\n```sh\n# npm\nnpm install textlint-plugin-mdx\n\n# Yarn\nyarn add textlint-plugin-mdx\n\n# pnpm\npnpm add textlint-plugin-mdx\n\n# Bun\nbun add textlint-plugin-mdx\n```\n\n## Usage\n\n\u003e [!CAUTION]\n\u003e If you have enabled the `.mdx` extension in [@textlint/textlint-plugin-markdown](https://www.npmjs.com/package/@textlint/textlint-plugin-markdown), please remove it.\n\n```json\n{\n  \"plugins\": {\n    \"mdx\": true\n  }\n}\n```\n\n## Options\n\n- `extensions`: `string[]`\n  - Additional file extensions for MDX\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. There is no need to use syntax such as `{/* \u003c!-- textlint-disable --\u003e */}`.\n\n```mdx\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\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-mdx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextlint%2Ftextlint-plugin-mdx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Ftextlint-plugin-mdx/lists"}