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

Code blocks in install docs include escaped vue interpolations #1042

Closed
zachmandeville opened this issue Oct 19, 2022 · 1 comment · Fixed by #1041
Closed

Code blocks in install docs include escaped vue interpolations #1042

zachmandeville opened this issue Oct 19, 2022 · 1 comment · Fixed by #1041
Labels
kind/bug A bug triage/accepted The issue was reviewed and is complete enough to start working on it

Comments

@zachmandeville
Copy link
Contributor

What happened?

In the Run Kuma section of the Install docs for macOS, there is a code block that will throw an error as it includes some Vuepress code that was not interpolated.

The current code block is:

ln -s kuma-{{ $page.latestVersion }}/bin/kumactl /usr/local/bin/kumactl

and it should be:

ln -s kuma-1.8.1/bin/kumactl /usr/local/bin/kumactl

The error is due to how vuepress interpets fenced blocks. Reading the source, this is already handled for other code examples by putting them in a <div class='language-sh'> block. It looks like this example used the wrong type of markup.

I've submitted a patch to fix this: #1041

@zachmandeville zachmandeville added kind/bug A bug triage/pending This issue will be looked at on the next triage meeting labels Oct 19, 2022
@lahabana lahabana linked a pull request Oct 19, 2022 that will close this issue
@lahabana lahabana added triage/accepted The issue was reviewed and is complete enough to start working on it and removed triage/pending This issue will be looked at on the next triage meeting labels Oct 19, 2022
@lahabana
Copy link
Contributor

Thx for the reporting and fixing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug A bug triage/accepted The issue was reviewed and is complete enough to start working on it
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants