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

swapping Usage content to not be header links #1334

Merged
merged 1 commit into from
Jun 24, 2017

Conversation

rouzbeh84
Copy link
Collaborator

@rouzbeh84 rouzbeh84 commented Jun 23, 2017

this is for #1306

Unless I'm missing something Usage links but the Examples subheaders are being pulled into sidebar when they shouldn't be?

screen recording of Usage working as expected

closes #1306

@rouzbeh84 rouzbeh84 requested a review from skipjack June 23, 2017 19:47
@skipjack
Copy link
Collaborator

skipjack commented Jun 24, 2017

So I think this will fix this instance but I think maybe the title I used for that issue caused some confusion. By "Link Usage" I meant using links in headers shouldn't display the actual markdown in the sidebar:

image

We may have to hack our markdown utility again (ugh) to fix this globally. However, I may merge this fix for now and come back to it down the road as I think we'll be updating our whole markdown parsing process soon anyway (see webpack-contrib/webpack-defaults#73).

@skipjack skipjack merged commit 4fc5edc into master Jun 24, 2017
@skipjack skipjack deleted the hotfix/usage-dll-subheader-link branch June 24, 2017 01:18
@rouzbeh84
Copy link
Collaborator Author

@skipjack totally agree on the header links thing. we'll see how it shakes out re:

we'll be updating our whole markdown parsing process soon anyway (see webpack-contrib/webpack-defaults#73).

But doc linking to a linked header could be as simple as adding the link title twice, once as an id as well as href when processed? Just a suggestion as I'm sure that'd probably have unintended implications in other parts of the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dev - Link Usage in Headers
2 participants