add doc for reserved metadata #514
Merged
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
| _disableToc | bool | Indicate whether to show table of contents on the left of page. | ||
| _disableAffix | bool | Indicate whether to show the affix bar on the right of page. | ||
| _disableContribution | bool | Indicate whether to show the `View Source` and `Improve this Doc` buttons. | ||
| gitContribute | object | Customized the `Improve this Doc` URL button for public contributors. Use `repo` to specify the contribution repository URL. Use `branch` to specify the contribution branch. Use `path` to specify the folder for new overwrite files . |
There was a problem hiding this comment.
shall we use _gitContribute to make this metadata consistent with others?
There was a problem hiding this comment.
Yes. doc issued is fixed, will rename it in code in another PR.
There was a problem hiding this comment.
gitContribute [](start = 0, length = 13)
how about give an example for gitContribute here?
|
👍 |
|
|
| ----------------------|---------|--------------------------- | ||
| _appTitle | string | Will be appended to each output page's head title. | ||
| _appFooter | string | The footer text. Will show DocFX's Copyright text if not specified. | ||
| _enableSearch | bool | Indicate whether show the search box on the top of page. |
There was a problem hiding this comment.
whether show [](start = 43, length = 12)
whether to show? #Closed
|
|
1 similar comment
|
|
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.
add doc for gitContribute #505
@chenkennt @ansyral @vwxyzh @qinezh @hellosnow