fix(docs): properly create links in guide files #2770
Merged
Conversation
This file contains hidden or 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
googlebot
added
the
cla: yes
jelbourn
reviewed
Jan 24, 2017
| `<div material-docs-example="${name}"></div>` | ||
| ); | ||
|
|
||
| content = content.replace(LINK_PATTERN, (match: string, pre: string, link: string) => |
There was a problem hiding this comment.
Can you add comments for what match, pre, and link are expected to contain? (just an example would be good)
There was a problem hiding this comment.
Added a comment explaining why pre is necessary. I think match and link should be self-explaining. Can change if desired.
* Adds a processor to the `gulp docs` task that can modify links for the Material documentation * Right now the processor just rewrites `/guides/` paths to `/guide/` and also removes the file extensions. This makes the guides work properly in the documentation.
devversion
force-pushed
the
fix/docs-links-ref
branch
from
ea89502 to
0bc06ab
Compare
jelbourn
added
pr: lgtm
action: merge
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
gulp docstask that can modify links for the Material documentation/guides/paths to/guide/and also removes the file extensions. This makes the guides work properly in the documentation.Note: This is initial implementation of the rewriting. It provides the functionality to rewrite paths and temporary also fixes guides for the documentation.
Fixes #2635