Repository navigation
Add a remark.rcPath setting so that a different file can be used for configuration #145
Description
Initial checklist
- I read the support docs
- I read the contributing guide
- I agree to follow the code of conduct
- I searched issues and discussions and couldn’t find anything (or linked relevant results below)
Problem
It is not uncommon to use remark for multiple purposes in a project. For example, it may be used for linting files such as README.md and also used for converting content files into HTML. As a result, I may have multiple remark configuration files - one for each use case.
I would like to name the configuration file for linting to be something like remarklint.config.js, but I can't if I want vscode-remark to pick it up.
Current solutions
Currently, the only approach is to reserve .remarkrc.js for the linting use case, and use different file names for the other configuration files.
Proposed solutions
With remark-cli I can specify which configuration file to use via the --rc-path option:
https://github.com/remarkjs/remark/tree/main/packages/remark-cli#cli
It would be nice if the user could likewise choose which configuration file to use in vscode-remark via a remark.rcPath setting.
The default configuration file can be left as .remarkrc.js, but now users would be able to change that if they wanted.
Activity
remcohaszing commentedon Jun 25, 2026
I recommend using default configuration files. This aligns with what other contributors to your project expect. This advice applies to other configuration files too, it’s not just for remark. Also other integrations might work better that way. For example, the JSON schema store and VSCode icons provide schema validation and file icons for
.remarkrc.jsonbased on static data.Regardless, this functionality is provided by
remark-cli. For parity, I agree it would be nice to have in the remark language server and VSCode extension as well. Most of the work will need to be done inunified-language-server. Thenremark-language-serverand this VSCode extension will need a documentation update.PRs welcome :)
github-actions commentedon Jun 25, 2026
Hi! This was marked as ready to be worked on! Note that while this is ready to be worked on, nothing is said about priority: it may take a while for this to be solved.
Is this something you can and want to work on?
Team: please use the
area/*(to describe the scope of the change),platform/*(if this is related to a specific one), andsemver/*andtype/*labels to annotate this. If this is first-timers friendly, addgood first issueand if this could use help, addhelp wanted.