pathLine config supported for section #1166
Closed
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
Codecov Report
|
sapegin
requested changes
Oct 8, 2018
| @@ -115,6 +115,7 @@ Each section consists of (all fields are optional): | |||
| - `ignore` — string/array of globs that should not be included in the section. | |||
| - `href` - an URL to navigate to instead of navigating to the section content | |||
| - `external` - if set, the link will open in a new window | |||
| - `pathLine` - if the section is associated with a particular source file, this can be passed to display a copy-able filepath | |||
There was a problem hiding this comment.
This doesn't really explain how it works. Something like this may be better:
Text to show with a copy to clipboard button below the heading, similar to component’s pathlines.
|
😴 This issue has been automatically marked as stale because it has not had recent activity. It will be closed in a week without any further activity. Consider opening a pull request if you still have this issue or want this feature. |
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.
This is useful for me because it allows me to use sections to document library exports that aren't React components, and still get the pathline feature that you get with generated React component docs.
Example:
