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.

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

Conversation

chfree
Copy link
Contributor

@chfree chfree commented Apr 13, 2020

修正了使用选项时注册插件的示例用法,对componentsDir中的somepath进行了示例说明

Summary

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

修正了使用选项时注册插件的示例用法,对componentsDir中的somepath进行了示例说明
@chfree chfree changed the title 修正plugin-register-components.md中的示例错误 docs($zh): fix plugin-register-components.md example error Apr 13, 2020
{
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

Copy link
Collaborator

@billyyyyy3320 billyyyyy3320 left a comment

Choose a reason for hiding this comment

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

Thanks again.

@billyyyyy3320 billyyyyy3320 merged commit b105089 into vuejs:master Apr 25, 2020
larionov pushed a commit to larionov/vuepress that referenced this pull request Aug 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants