Skip to content

docs($zh): fix plugin-register-components.md example error #2300

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 25, 2020
Merged

docs($zh): fix plugin-register-components.md example error #2300

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbb96ee
修正plugin-register-components.md中的示例错误
chfree Apr 13, 2020
23a20da
Modify the somepath description
chfree Apr 15, 2020
318b8c8
remove somepath description
chfree Apr 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/docs/docs/zh/plugin/official/plugin-register-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,15 @@ module.exports = {
module.exports = {
plugins: [
[
'register-components',
'@vuepress/register-components',
{
componentsDir: somepath
}
]
]
}
```
`somepath`是从`docs`目录开始,比如：`docs/.vuepress/components/custom-path/`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It depends. The directory name is not required to be docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks The somepath description has been modified

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So somepath might've confused you. That's why you want to add an additional line, right?

Thanks a lot for your help to improve docs. Could you also update the EN docs for this line?
Besides, I'd suggest placing them right after somepath as comment.

Or you can leave it to me and just remove this line to let this PR focus on fixing example error.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok,somepath is deleted


### components

Expand All @@ -55,7 +56,7 @@ module.exports = {
module.exports = {
plugins: [
[
'register-components',
'@vuepress/register-components',
{
components: [
{
Expand Down