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

bug: How to deal with {{<code>}} blocks #28

Open
Jayclifford345 opened this issue Jun 26, 2024 · 2 comments
Open

bug: How to deal with {{<code>}} blocks #28

Jayclifford345 opened this issue Jun 26, 2024 · 2 comments
Labels
bug Something isn't working transformer Issues for docs to killercoda tool

Comments

@Jayclifford345
Copy link
Collaborator

Notice how I mis-copy/pasted and I "end a block" before it started. Below this block, I end it a second time. No warnings either time, no step5 emitted by the transformer. Ideally, the code would say "hey dude you ended something before you started it" and fail.

@Jayclifford345
Copy link
Collaborator Author

Options:

  1. Do we omit only code block tagged automatically with a macos or windows tag?
  2. Do we actively ask users to put them entire code block in ignore tags and write a separate killercoda include

@Jayclifford345 Jayclifford345 added bug Something isn't working enhancement New feature or request transformer Issues for docs to killercoda tool and removed enhancement New feature or request labels Jun 26, 2024
@jdbaldry
Copy link
Member

So the code shortcode can be used for more than just different distributions. It can also be different languages for SDK documentation or something like that.

Ideally, I think all options should be present in the Killercoda tutorial but presenting that information may be challenging.
Perhaps there should also be a mechanism to suppress specific blocks like macos that won't ever work in the ILE.

Maybe Killercoda have their own implementation of tabbed snippets? I don't see anything like a Markdown reference on their site though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working transformer Issues for docs to killercoda tool
Projects
None yet
Development

No branches or pull requests

2 participants