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.

Sign up for GitHub

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

Jump to bottom

Document hugo shortcode usage for admonitions #335

Closed
jorgemoralespou opened this issue Apr 9, 2024 · 0 comments · Fixed by #342
Closed

Document hugo shortcode usage for admonitions #335

jorgemoralespou opened this issue Apr 9, 2024 · 0 comments · Fixed by #342
Labels
area/docs Issues that have any relation with the docs enhancement New feature or request

Comments

@jorgemoralespou
Copy link
Contributor

Is your feature request related to a problem? Please describe.

We currently support 3 admonitions (note, warning and danger) as hugo shortcodes: https://github.com/vmware-tanzu-labs/educates-training-platform/tree/develop/workshop-images/base-environment/opt/eduk8s/etc/themes/educates/layouts/shortcodes

These can be used like:

{{< warning >}}
text
{{< /warning >}}

But this is not found on the docs.

Describe the solution you'd like

Document this on https://docs.educates.dev/workshop-content/workshop-instructions# page

Describe alternatives you've considered

No response

Additional information

No response
@jorgemoralespou jorgemoralespou added enhancement New feature or request area/docs Issues that have any relation with the docs labels Apr 9, 2024
mocdaniel added a commit to mocdaniel/educates-training-platform that referenced this issue Apr 23, 2024
@mocdaniel
Add admonition shortcodes to workshop-content docs
8de4228 
This commit adds documentation of the three
admonition shortcodes available in Educates
(note, warning, danger) to the docs at
workshop-content/workshop-instructions.

Resolves: vmware-tanzu-labs#335
mocdaniel added a commit to mocdaniel/educates-training-platform that referenced this issue Apr 23, 2024
@mocdaniel
Add admonition shortcodes to workshop-content docs
e95d7f1 
This commit adds documentation of the three
admonition shortcodes available in Educates
(note, warning, danger) to the docs at
workshop-content/workshop-instructions.

Resolves: vmware-tanzu-labs#335
@mocdaniel mocdaniel mentioned this issue Apr 23, 2024
Merged
mocdaniel added a commit to mocdaniel/educates-training-platform that referenced this issue Apr 23, 2024
@mocdaniel
Add admonition shortcodes to workshop-content docs
d99b73e 
This commit adds documentation of the three
admonition shortcodes available in Educates
(note, warning, danger) to the docs at
workshop-content/workshop-instructions.

Resolves: vmware-tanzu-labs#335
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs Issues that have any relation with the docs enhancement New feature or request
Projects
Educates Training Platform
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add admonition shortcodes to workshop-content docs mocdaniel/educates-training-platform
1 participant
@jorgemoralespou