feat: register globally theme components (close #281)

[hmatalonga]

This pull request allows to register theme components globally, just like the components in .vuepress/components.

It makes use of options.themePath to include all *.vue in a components sub-folder to follow the existing logic.

Closes #281

[meteorlxy]

For me, I prefer to put the components of my custom theme in the themePath/components directory, rather than register them as global components.

What about themePath/globalComponents ?

I don't know which solution is better, may need more discussions.

[hmatalonga]

Sure thing, we should hear about the general consensus which place to put the components 👍

[yliaho]

I agree with @meteorlxy – globalComponents (or similar) would be preferable.

[hmatalonga]

Giving it some more thought, I agree it makes perfectly sense to have a dedicated globalComponents where only those ones are registered.

I can make that change, if you feel like it's an adequate solution for everyone 👍

[ulivz]

Thanks for this work!

Consider this feature can be finished by a plugin. just hold it until our plugin is released. Not too long.😅

[sebiniemann]

Regarding the path name, I would vote for either for components or to rename .vuepress/components to .vuepress/globalComponents.

Differentiating the folder name between .vuepress and a theme, while serving the same purpose, seems to be an avoidable learning curve increase.

I like to think about themes as a common .vuepress functionality between multiple sites. Therefore being as closely related to each other as possible.

[AuditorCJ]

Giving it some more thought, I agree it makes perfectly sense to have a dedicated globalComponents where only those ones are registered.

I can make that change, if you feel like it's an adequate solution for everyone +1

[hmatalonga]

@AuditorCJ

It was decided to wait until the plugin API is released, to add this feature as a plugin then we will revisit this discussion and decide on which directory naming to follow 😉

[ulivz]

In 1.x, structure of a theme would be:

theme
├── global-components
│   └── xxx.vue
├── components
│   └── xxx.vue
├── layouts
│   ├── Layout.vue (Mandatory)
│   └── 404.vue
├── styles
│   ├── index.styl
│   └── palette.styl
├── index.js
├── enhanceApp.js
└── package.json

And those components under global-components will be registered as global components.

ref: https://v1.vuepress.vuejs.org/theme/writing-a-theme.html#directory-structure