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

doc: Remove code block from command reference #92

Closed
wants to merge 1 commit into from

Conversation

katiefenn
Copy link

@katiefenn katiefenn commented Nov 6, 2018

Remove code block from npm command reference

What I Wanted to Do

I want the link to npm config in the npm-config article to not be rendered in a <code> block.

What Happened Instead

This command reference is transcoded from markdown to HTML, this reference appears within a <code> block. This is interpreted in various ways by different markdown preprocessors:


marky-markdown styles the text using a monospace typeface.
screen shot 2018-11-06 at 14 37 57


kramdown escapes the HTML:
screen shot 2018-11-06 at 14 39 33

This is causing an issue for an internal docs project.

@katiefenn katiefenn requested a review from a team as a code owner November 6, 2018 14:40
@zkat zkat added the docs label Nov 13, 2018
@zkat
Copy link
Contributor

zkat commented Nov 13, 2018

cc @neverett

@zkat zkat changed the base branch from latest to release-next November 13, 2018 15:28
@neverett
Copy link
Contributor

neverett commented Dec 5, 2018

This is fixed by https://github.com/npm/help-docs/pull/119, so I think this PR can be closed w/o merging.

@aeschright aeschright closed this Jan 9, 2019
@claudiahdz claudiahdz deleted the remove-code-block-from-command branch December 11, 2019 15:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants