remark for Visual Studio Code
Visual Studio Code extension to format and lint markdown files with remark.
What is this?
This project is a Visual Studio Code (VS Code) extension that you can use in your editor to inspect and change markdown files. This extension is built around remark, which is a very popular ecosystem of plugins that work with markdown. You can choose from the 150+ plugins that already exist or make your own.
See remark for info on what the remark ecosystem is.
When should I use this?
You can use this extension if you want to check (lint) and format markdown files from within your editor.
To configure this extension, you define your preferred markdown style in a
configuration file (
The configuration file is also used by
Get it on the VS Code Marketplace or install it by using Quick Open (Ctrl + P) and running the following:
To use this extension, set up
Now, you can open markdown files in your project, and you’ll see squiggly lines
and warnings in the
This extension can format markdown files.
To format a file, pull up the command pallete (Ctrl + Shift + P), choose
Now markdown documents can be formatted using Ctrl + Shift + I.
You can optionally choose to automatically format when saving with
The remark ecosystem has a variety of plugins available.
Most notably you’ll want to check out
This extension is compatible with Visual Studio Code versions 1.67.0 and greater.
This plugin loads configuration files, plugins, and presets from your workspace. Only use this plugin in workspaces you trust.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
MIT © Denis Malinochkin