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

Update editCode shortcode delimiter #370

Closed
plumbis opened this issue Feb 28, 2023 · 0 comments · Fixed by #470
Closed

Update editCode shortcode delimiter #370

plumbis opened this issue Feb 28, 2023 · 0 comments · Fixed by #470
Assignees
Labels
bug Something isn't working infrastructure Issues related to the docs HTML, CSS, JS or hosting P3 Nice to have issues. Should be prioritized to be eventually resolved.

Comments

@plumbis
Copy link
Collaborator

plumbis commented Feb 28, 2023

Currently the editCode shortcode uses $$ to mark what can be edited.

The markdown render engine will wrap $$ in a span tag, but not the content inside. This breaks the shortcode.

Testing shows that @@ will work as expected.

This is a simple fix but needs to be done with no open PRs so that existing uses of editCode can be updated.

@plumbis plumbis added bug Something isn't working P3 Nice to have issues. Should be prioritized to be eventually resolved. infrastructure Issues related to the docs HTML, CSS, JS or hosting labels Feb 28, 2023
@plumbis plumbis self-assigned this Feb 28, 2023
plumbis added a commit to plumbis/crossplane-docs that referenced this issue May 15, 2023
Signed-off-by: Pete Lumbis <pete@upbound.io>
plumbis added a commit to plumbis/crossplane-docs that referenced this issue Jun 20, 2023
Signed-off-by: Pete Lumbis <pete@upbound.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working infrastructure Issues related to the docs HTML, CSS, JS or hosting P3 Nice to have issues. Should be prioritized to be eventually resolved.
Projects
None yet
1 participant