{"id":28573728,"url":"https://github.com/remarkjs/vscode-remark","last_synced_at":"2025-06-10T21:19:47.659Z","repository":{"id":37030514,"uuid":"68968222","full_name":"remarkjs/vscode-remark","owner":"remarkjs","description":"Lint and format markdown code with remark","archived":false,"fork":false,"pushed_at":"2024-04-18T09:10:03.000Z","size":748,"stargazers_count":52,"open_issues_count":2,"forks_count":11,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-04-19T10:14:25.753Z","etag":null,"topics":["remark","remarkjs","visual-studio-code","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-remark","language":"JavaScript","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/remarkjs.png","metadata":{"funding":{"github":"unifiedjs","open_collective":"unified"},"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"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}},"created_at":"2016-09-22T22:45:56.000Z","updated_at":"2024-04-07T09:11:28.000Z","dependencies_parsed_at":"2024-04-18T09:32:13.816Z","dependency_job_id":"fc294412-a763-4c55-85c9-589ab50674e1","html_url":"https://github.com/remarkjs/vscode-remark","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fvscode-remark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fvscode-remark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fvscode-remark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fvscode-remark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remarkjs","download_url":"https://codeload.github.com/remarkjs/vscode-remark/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remarkjs%2Fvscode-remark/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259152855,"owners_count":22813237,"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":["remark","remarkjs","visual-studio-code","vscode","vscode-extension"],"created_at":"2025-06-10T21:19:11.353Z","updated_at":"2025-06-10T21:19:47.502Z","avatar_url":"https://github.com/remarkjs.png","language":"JavaScript","funding_links":["https://github.com/sponsors/unifiedjs","https://opencollective.com/unified"],"categories":[],"sub_categories":[],"readme":"# remark for Visual Studio Code\n\n[![Build][build-badge]][build]\n[![Downloads][downloads-badge]][marketplace]\n[![Sponsors][sponsors-badge]][collective]\n[![Backers][backers-badge]][collective]\n[![Chat][chat-badge]][chat]\n\nVisual Studio Code extension to format and lint markdown files with remark.\n\n## Contents\n\n* [What is this?](#what-is-this)\n* [When should I use this?](#when-should-i-use-this)\n* [Install](#install)\n* [Use](#use)\n* [Configuration file](#configuration-file)\n* [Settings](#settings)\n* [Formatting](#formatting)\n* [Plugins](#plugins)\n* [Compatibility](#compatibility)\n* [Security](#security)\n* [Contribute](#contribute)\n* [License](#license)\n\n## What is this?\n\nThis project is a Visual Studio Code (VS Code) extension that you can use in\nyour editor to inspect and change markdown files.\nThis extension is built around remark, which is a very popular ecosystem of\nplugins that work with markdown.\nYou can choose from the 150+ plugins that already exist or make your own.\n\nSee [remark][] for info on what the remark ecosystem is.\n\n## When should I use this?\n\nYou can use this extension if you want to check (lint) and format markdown\nfiles from within your editor.\n\nTo configure this extension, you define your preferred markdown style in a\nconfiguration file (`.remarkrc`, `.remarkrc.js`, etc. or in `package.json`).\nThis file is picked up by `vscode-remark` and other tools (useful for\ncontributors that don’t use VS Code).\n\nThe configuration file is also used by [`remark-cli`][remark-cli], which is\nrecommended to be used alongside `vscode-remark`, as an npm script and/or in\nCI, to enforce the markdown style.\n\n## Install\n\n[Get it on the VS Code Marketplace][marketplace] or install it by using Quick\nOpen (\u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eP\u003c/kbd\u003e) and running the following:\n\n```txt\next install unifiedjs.vscode-remark\n```\n\n## Use\n\nTo use this extension, set up [`remark-cli`][remark-cli] like you normally would\nin your project with a configuration file.\nThe extension will find the configuration in your workspace just like running\n`remark-cli` in your terminal would.\nYou will be able to see your linter work as you type and you can format your\ncode if you want it to.\n\nNow, you can open markdown files in your project, and you’ll see squiggly lines\nand warnings in the `Problems` pane if the code doesn’t adhere to the coding\nstandards.\nHere’s an example that should produce problems you can use to verify:\n\n```markdown\n1) Hello, _Jupiter_ and *Neptune*!\n```\n\n## Configuration file\n\n`remark-language-server` uses the same configuration files as\n[`remark-cli`][remark-cli].\nThese files are:\n\n* `.remarkrc`\n* `.remarkrc.cjs`\n* `.remarkrc.js`\n* `.remarkrc.json`\n* `.remarkrc.mjs`\n* `.remarkrc.yaml`\n* `.remarkrc.yml`\n* `package.json`\n\nLanguage clients should notify the language server if these files change.\nThey are looked up starting at the folder where the checked markdown file\nexists.\n\n## Settings\n\nThis extension supports the following settings:\n\n* `remark.requireConfig` (`boolean`, default: `false`) — If true, only perform\n  actions if a [configuration file][configuration-file] is found.\n\n## Formatting\n\nThis extension can format markdown files.\n\nTo format a file, pull up the command pallete (\u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eShift\u003c/kbd\u003e + \u003ckbd\u003eP\u003c/kbd\u003e), choose `Format Document With…`, and select\n`remark`.\n\nTo make `vscode-remark` the default formatter for markdown, add the following to\nyour `settings.json` (which you can open with \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003e,\u003c/kbd\u003e):\n\n```json\n{\n  \"[markdown]\": {\n    \"editor.defaultFormatter\": \"unifiedjs.vscode-remark\"\n  }\n}\n```\n\nNow markdown documents can be formatted using \u003ckbd\u003eCtrl\u003c/kbd\u003e + \u003ckbd\u003eShift\u003c/kbd\u003e + \u003ckbd\u003eI\u003c/kbd\u003e.\n\nYou can optionally choose to automatically format when saving with\n`editor.formatOnSave`:\n\n```json\n{\n  \"[markdown]\": {\n    \"editor.defaultFormatter\": \"unifiedjs.vscode-remark\",\n    \"editor.formatOnSave\": true\n  }\n}\n```\n\n## Plugins\n\nThe **remark** ecosystem has a variety of plugins available.\nMost notably you’ll want to check out [`remark-lint`][remark-lint].\nSee this curated [list of plugins][list-of-plugins] for more remark plugins.\n\n## Compatibility\n\nThis extension is compatible with Visual Studio Code versions 1.67.0 and\ngreater.\n\n## Security\n\nThis plugin loads configuration files, plugins, and presets from your workspace.\nOnly use this plugin in workspaces you trust.\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways\nto get started.\nSee [`support.md`][support] for ways to get help.\nJoin us in [Discussions][chat] to chat with the community and contributors.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © Denis Malinochkin\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/remarkjs/vscode-remark/workflows/main/badge.svg\n\n[build]: https://github.com/remarkjs/vscode-remark/actions\n\n[configuration-file]: #configuration-file\n\n[downloads-badge]: https://img.shields.io/visual-studio-marketplace/d/unifiedjs.vscode-remark\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/remarkjs/remark/discussions\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[health]: https://github.com/remarkjs/.github\n\n[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md\n\n[support]: https://github.com/remarkjs/.github/blob/main/support.md\n\n[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md\n\n[collective]: https://opencollective.com/unified\n\n[license]: license\n\n[marketplace]: https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-remark\n\n[remark-lint]: https://github.com/remarkjs/remark-lint\n\n[remark]: https://github.com/remarkjs/remark\n\n[remark-cli]: https://github.com/remarkjs/remark/tree/main/packages/remark-cli\n\n[list-of-plugins]: https://github.com/remarkjs/remark/blob/main/doc/plugins.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkjs%2Fvscode-remark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremarkjs%2Fvscode-remark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremarkjs%2Fvscode-remark/lists"}