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

Support for Markdown Callouts in Exercise Description #10116

Closed
martin-fink opened this issue Jan 8, 2025 · 2 comments · Fixed by #10158
Closed

Support for Markdown Callouts in Exercise Description #10116

martin-fink opened this issue Jan 8, 2025 · 2 comments · Fixed by #10158
Assignees
Labels
exam Pull requests that affect the corresponding module exercise Pull requests that affect the corresponding module feature lecture Pull requests that affect the corresponding module

Comments

@martin-fink
Copy link

Is your feature request related to a problem?

Sometimes, it would be helpful to give hints or tips to students, which are not easily missed. Currently, I am writing them like this:

Important: Make sure not to create bugs.

Warning: Do not use class xyz.

Describe the solution you'd like

I'd like to use callouts instead. Rendering them like e.g. Github does it would make it harder to miss important tips. Example:

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Describe alternatives you've considered

No response

Additional context

Currently, Artemis does not support callouts. They are rendered as normal quotes:
Screenshot 2025-01-08 at 10 03 18

@github-actions github-actions bot added exam Pull requests that affect the corresponding module exercise Pull requests that affect the corresponding module lecture Pull requests that affect the corresponding module labels Jan 8, 2025
@krusche
Copy link
Member

krusche commented Jan 8, 2025

Great idea 👍🏻 can you check if there is a markdown plugin which can render this that is compatible with the markdown library that the Artemis client is using?

Then, it should be super easy to implement this feature

@tobias-lippert
Copy link
Contributor

@martin-fink I've found a suitable plugin and implemented it.
@krusche can you please assign the issue to me as I cannot assign it to me myself and it seems I'm missing rights to push to the repository at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exam Pull requests that affect the corresponding module exercise Pull requests that affect the corresponding module feature lecture Pull requests that affect the corresponding module
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants