Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider changing config.js to vitepress.config.js #4151

Open
ghost opened this issue Aug 20, 2024 · 0 comments
Open

Consider changing config.js to vitepress.config.js #4151

ghost opened this issue Aug 20, 2024 · 0 comments
Labels

Comments

@ghost
Copy link

ghost commented Aug 20, 2024

Is your feature request related to a problem? Please describe.

Hello.
VitePress is doing great, I have simply a suggestion for your next major version.

JavaScript softwares tend to recognize their config files with the software name as a prefix to the word "config" written on it. This is not a rule, it may only be the most frequent convention. of course there are other possibilities and all are valid,

Describe the solution you'd like

I would not care, but to be frank to you, days have gone by before I realized that "config" was an abbreviation for "vitepress config" in the file config.js. I did not immediately recognized this file as the config file for VitePress. Even now, I can't put my mind to read it as "vitepress config" when I pass my eyes on it, maybe because in other softwares, a folder that starts with a dot, like ".vitepress", is commonly reserved to temporary files like cache. Besides that, in this folder we end up setting up configuration for plugins. So directly recognizing a "config.js" as "vitepress config" requires a little effort. VitePress settings in a sense are defined on theme files, so it is easy to discard this file when you are having your first contact. In this ecosystem, in which config is a word with multiple meanings, it would be welcome to rethink the "config.js".

Describe alternatives you've considered

In order to ease comprehension, vitepress.config.js (and its format variations) could be the expected file, instead of config.js. It is easier to recognize, since there are more examples (astro.config.js, babel.config.js, capacitor.config.js, docusaurus.config.js, eleventy.config.js, eslint.config.js, farm.config.js, gatsby-config.js, iles.config.js, jest.config.js, lume.config.js, nativescript.config.js, next.config.js, nuxt.config.js, prettier.config.js, remix.config.js, stylelint.config.js, tailwind.config.js, tsconfig.json, vite.config.js, vitest.config.js, vue.config.js, webpack.config.js, ...)

All the best

@github-actions github-actions bot added the stale label Sep 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

0 participants