You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
The text was updated successfully, but these errors were encountered: