Spike: How can we make shortcodes presentable in /help?
A powerful feature in Hugo is the ability to create custom shortcodes. These will allow us to more easily implement content formatting options that don't exist in regular markdown (e.g, alert boxes, tabs).
However, these will only render properly on the website. Pages in /help
are only processed through markdown, not Hugo, and so those would look something like this:
(The things like {{% card header="Benefits" %}}
are shortcodes that would render on a compiled website, but not /help
.)
Open questions
- What would we need to do in
/help
to make these not look so strange? -
Not shortcodes, but related: what do we do about page titles (moving fromResolved via gitlab-org/gitlab!145627 (merged)h1
s to thetitle
front matter attribute) - How could we use template partials for reusable content, like the legal disclaimer introduced in !43 (merged), without obscuring that content too much in
/help
?- Note that if we don't solve for this, we'll need to refactor the Disclaimer alert box so that the disclaimer content will be replicated in each instance of it rather than called from the shared file.
Edited by Sarah German