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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

add keyconcept box #33

Closed
lucaferranti opened this issue Jun 28, 2023 · 3 comments 路 Fixed by #34
Closed

add keyconcept box #33

lucaferranti opened this issue Jun 28, 2023 · 3 comments 路 Fixed by #34

Comments

@lucaferranti
Copy link
Member

lucaferranti commented Jun 28, 2023

Hi,

thanks for this very useful package, would you be interested in having something like

function key_concept(concept, text)
	aside(Markdown.MD(Markdown.Admonition("key-concept", "馃幆  remember", [md"**$concept**", text])))
end

It looks like the following

image

I am writing some teaching material for my class in the form of book/website and I am using something like that to highlight the key-concepts from the text. I can upstream it here if you think it would be useful to others too

@eford
Copy link
Collaborator

eford commented Jun 30, 2023

I'm glad to hear it's helpful to people.
A key concept box seems like a potentially common use case.
For tip(...), we separated out making the admonition and choosing to placing it to the side. Would you be happy making so that your above example would be called by aside(key_concept(concept, text))?

@eford
Copy link
Collaborator

eford commented Jun 30, 2023

Is "remember" the best prompt? What about "Key concept"?
To fit the multi-language pattern, you'd need to put that in a language-specific function anyway. So feel free to start implementing it and we can swap out the specific wording before merging it.

@lucaferranti
Copy link
Member Author

Would you be happy making so that your above example would be called by aside(key_concept(concept, text))?

yes, I also thought about this after posting the issue. This is better, since it offers more flexibility and users can choose where to put the box themselves

Is "remember" the best prompt? What about "Key concept"?

pretty agnostic about the name, Key concept might indeed be better. It is also better aligned with the proposed name of the function key_concept.

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 a pull request may close this issue.

2 participants