Skip to content
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

docs: Add section about configuration override #2309

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: Add section about configuration override #2309

wants to merge 2 commits into from

Conversation

cyrilf
Copy link
Contributor

@cyrilf cyrilf commented Apr 14, 2020

Summary

Add more information about how to override the parent theme default configuration when extending a theme.

If this get accepted, the Chinese documentation still needs to be updated accordingly.

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:

Related to #2296

@Mister-Hope
Copy link
Contributor

Mister-Hope commented Apr 15, 2020

By the way, I can help with the Chinese parts. Just call me if you want to merge it. (To core team)

Copy link
Member

@ulivz ulivz left a comment

Choose a reason for hiding this comment

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

I think there is some noise here, you're overriding user's themeConfig instead of config from parent theme.

So this may should not be unsuited to document here.

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.

3 participants