Skip to content

docs: clarify theme config files in code blocks (close #2533) #2534

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

Conversation

peteruithoven
Copy link
Contributor

@peteruithoven peteruithoven commented Jul 24, 2020

Fixes: #2533

Summary
Clarify what files config file examples refer to.

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:
I'm not sure if .vuepress/theme/index.js or themePath/index.js is more appropriate & understandable. I'm Happy to change it to themePath/index.js.

@billyyyyy3320 billyyyyy3320 changed the title docs: clarify theme config files Fix: #2533 docs: clarify theme config files in code blocks (close #2533) Aug 23, 2020
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 for your help! We also need to update code blocks in zh version. Is that okay to leave it to you?

@peteruithoven
Copy link
Contributor Author

@billyyyyy3320 I've added paths to the same codeblocks in zh :)

@billyyyyy3320 billyyyyy3320 merged commit 8999aba into vuejs:master Aug 25, 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.

Docs: Clarify config file
2 participants