feat: Add docsRepo #155
Merged
feat: Add docsRepo #155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In some cases, project and doc are not in the same repo like Vue. So, and a `docRepo` option in config file to distinguish project and doc address.
ulivz
requested changes
Apr 19, 2018
|
Didn't see the const definition just now @ulivz |
ulivz
reviewed
Apr 19, 2018
docs/default-theme-config/README.md
Outdated
| @@ -226,6 +226,8 @@ module.exports = { | |||
| themeConfig: { | |||
| // Assumes GitHub. Can also be a full GitLab url. | |||
| repo: 'vuejs/vuepress', | |||
| // Your docs repo address | |||
There was a problem hiding this comment.
Optional, your docs repo address, fallback to repo when it's not given.
|
Ok, does there something still need to change? @ulivz |
abdullah
reviewed
Apr 20, 2018
| if (repo && editLinks) { | ||
| const base = outboundRE.test(repo) | ||
| ? repo | ||
| : `https://github.com/${repo}` |
There was a problem hiding this comment.
It can take a full URL to handle repositories
There was a problem hiding this comment.
yes it was preserved, I just changed the var name from repo to docsRepo.
egoist
reviewed
Apr 21, 2018
lib/default-theme/Page.vue
Outdated
| @@ -57,18 +57,19 @@ export default { | |||
| docsDir = '', | |||
| docsBranch = 'master' | |||
| } = this.$site.themeConfig | |||
There was a problem hiding this comment.
Add docsRepo = repo here seems clearer 😄
egoist
reviewed
Apr 21, 2018
docs/default-theme-config/README.md
Outdated
| @@ -226,6 +226,8 @@ module.exports = { | |||
| themeConfig: { | |||
| // Assumes GitHub. Can also be a full GitLab url. | |||
| repo: 'vuejs/vuepress', | |||
| // Optional, your docs repo address, fallback to repo when it's not given. | |||
There was a problem hiding this comment.
Defaults to `themeConfig.repo`
There was a problem hiding this comment.
@egoist
Seems the same meaning
There was a problem hiding this comment.
It is clearer if u specify themeConfig.repo
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In some cases, project and doc are not in the same repo like Vue. So, and a
docsRepooption in config file to distinguish project and doc address.