Markdown render hooks for code blocks

[acalvo]

Would it be possible to have markdown render hooks for code blocks, just as we do for links and images since v0.62?

Say I want to add a "copy" button in all code snippets in my site. Right now I'm forced to use a shortcode around my code snippets that adds it. If we had something similar to link/image render hooks, we could keep using standard markdown syntax and implement these kind of features in an elegant way.

[frerich]

I would love to have this. Right now, I use a custom short code (e.g. {{< code language="perl" >}}) but that doesn't work too well with common Markdown editors (e.g. Typora).

In case this is implemented, it would be great if the entire info string of fenced code blocks is passed to the render hook. Right now, my short code supports specifying an optional caption for the code snippet, e.g. {{< code language="perl" caption"After refactoring the login function" >}}. It would be great if I coculd use e.g.

```perl "After refactoring the login function"
...
```

or something along the lines of that to specify an optional caption.

[maelle]

A render hook for code blocks would also make it possible (I think?) to add links to documentation / hover information on some elements inside the code blocks.

Something like GitHub code navigation.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. The resources of the Hugo team are limited, and so we are asking for your help.
If this is a bug and you can still reproduce this error on the master branch, please reply with all of the information you have about it in order to keep the issue open.
If this is a feature request, and you feel that it is still relevant and valuable, please tell us why.
This issue will automatically be closed in the near future if no further activity occurs. Thank you for all your contributions.

[frerich]

I'd still greatly appreciate this feature. To avoid that this ticket gets closed due to a lack of activity, I'd like to summarise.

There are many plausible features associated with code blocks:

• Adding a 'Copy' button next to each code snippet which lets users copy the code block to the clipboard
• Custom (more semantic?) HTML markup
• Adding a caption to each code snippet
• Adding hyperlinks to code blocks (e.g. having function calls automatically reference the relevant API documentation)

Right now, implementing any of these features requires a custom shortcode. However, a shortcode has a number of downsides:

• Fellow authors need to be taught about it - it's a custom extension to Markdown
• Tool need to be (but usually cannot be) taught about it. As a consequence, popular Markdown editors like Typora won't highlight code snippets marked up with a custom shortcode as code.

[kdabir]

I can add one more use case

To be able to process something like mermaid using standard code fence

```mermaid
     graph TD
         Start --> Stop
```

Shortcodes block are not rendered as code in any text editors or even on Github, making it very hard to read block as a Markdown content. for example, the following content loses indentation, very bad for copy paste:

{{< mermaid >}}
graph TD
Start --> Stop
{{< /mermaid >}}

I would love to see hooks for code blocks and even inline code. IMHO, the more we can get out from standard markdown syntax the better it is for the entire ecosystem 🙏 .

[bep]

In case this is implemented, it would be great if the entire info string of fenced code blocks is passed to the render hook.

You would get a map of .Attributes in your hook, so you could make up your own, e.g.:

```bash
echo "foo";
```
{comment="Hugo is cool"}

Which would allow this hook:

{{ comment := .Attributes.comment }}

(note to self: #8313)

[shafiemukhre]

I really need this, is anyone is working on this? I would like to work on this and appreciate any guidance or direction and files that I need to update/modified? Thank you so much

This will be my first issue

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.