Style a Markdown Table With Bootstrap Classes in Hugo
Published: Dec 12, 2018
Updated: Jan 14, 2022
Updated: Jan 14, 2022
Inspired by this discussion, I wanted the ability to style a markdown table with Bootstrap table classes. In the past, I’ve accomplished this by defining the table in a data file, then building it with a shortcode.
While this works fine, it’s better for a different use case. I wanted something that meets the following criteria:
- The table is defined in markdown
- It lives in the content file, e.g.
content/post/some-post.md
- It’s styled with Bootstrap table classes
After a bit of tinkering, here’s the shortcode I came up with. To use it, pass the markdown table between the shortcode, then pass the Bootstrap table classes as an argument.
Usage #
{{< bootstrap-table "table table-dark table-striped table-bordered" >}}
| Animal | Sounds |
|---------|--------|
| Cat | Meow |
| Dog | Woof |
| Cricket | Chirp |
{{< /bootstrap-table >}}
Definition #
{{ $htmlTable := .Inner | markdownify }}
{{ $class := .Get 0 | default "" }}
{{ $old := "<table>" }}
{{ $new := printf "<table class=\"%s\">" $class }}
{{ $htmlTable := replace $htmlTable $old $new }}
{{ $htmlTable | safeHTML }}