aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2021-10-25 18:44:54 -0400
committerPaul Duncan <pabs@pablotron.org>2021-10-25 18:44:54 -0400
commit732e3a7807e2846eea207a8da9343d1ca9457bf0 (patch)
tree3dc2e8598b4673975b05e8f6584c1ad6234b0761
parent6af9b6dc93079ef32d51eeb44f854ef628c5b182 (diff)
downloadpablotron.org-732e3a7807e2846eea207a8da9343d1ca9457bf0.tar.bz2
pablotron.org-732e3a7807e2846eea207a8da9343d1ca9457bf0.zip
articles/table-shortcode-examples: fix repo url, add link for shortcodes
-rw-r--r--content/articles/table-shortcode-examples.md35
1 files changed, 18 insertions, 17 deletions
diff --git a/content/articles/table-shortcode-examples.md b/content/articles/table-shortcode-examples.md
index b9415a0..b3abd5d 100644
--- a/content/articles/table-shortcode-examples.md
+++ b/content/articles/table-shortcode-examples.md
@@ -494,8 +494,8 @@ tables:
## Introduction
-This shortcode is a replacement for the lackluster table syntax in the
-default [Hugo Markdown renderer][goldmark].
+This [shortcode][] is a replacement for the lackluster table syntax in
+the default [Hugo Markdown renderer][goldmark].
Features:
* Emits [CSS][] classes for alignment rather than inline `style`
@@ -507,18 +507,17 @@ Features:
* Easy to configure emitted [CSS][] classes for a variety of frameworks,
including [Bulma][] and [Bootstrap][].
-[GitHub Repository][hugo-shortcode-table]
+[GitHub Repository][git]
## Quick Start
To get started:
-1. Copy `table.html` from the [hugo-shortcode-table
- repository][hugo-shortcode-table] to the `layouts/shortcodes`
- directory for your site.
+1. Copy `table.html` from the [hugo-shortcode-table repository][git] to
+ the `layouts/shortcodes` directory for your site.
2. Add a table definition to your [page front matter][front matter] (see
below).
-3. Add a `table` shortcode to your page content which references the
+3. Add a `table` [shortcode][] to your page content which references the
table definition from the previous step (see below).
Here is an example table definition for [YAML][] [front matter][]:
@@ -633,18 +632,18 @@ tables:
#### Site Data Tables
Tables can also be defined in the [site `data` directory][site data] by
-using the two-argument version of the `table` shortcode.
+using the two-argument form of the `table` [shortcode][].
-Here is an example of the two argument version of of the `table`
-shortcode: For example:
+Here is an example of the two argument form of of the `table`
+shortcode:
```md
{{</* table "table_shortcode_examples" "fruits" */>}}
```
&nbsp;
-In the example above, the `table` shortcode will look for the table data
-in the file `data/tables/table_shortcode_examples/fruits.yaml`.
+In the example above, the `table` [shortcode][] will look for the table
+data in the file `data/tables/table_shortcode_examples/fruits.yaml`.
##### Data File
@@ -706,7 +705,7 @@ tables:
#### Content
-Here is the corresponding table short code from the page content:
+Here is the corresponding table [shortcode][] from the page content:
```md
{{</* table "table_caption" */>}}
@@ -767,7 +766,7 @@ tables:
#### Page Content
-Here is the corresponding table shortcode reference from the page
+Here is the corresponding table [shortcode][] reference from the page
content for the table defined in the previous section:
```md
@@ -1292,7 +1291,7 @@ Here is the generated table:
Use the `table_config` property in the [page front matter][front matter]
to override the configuration for all tables on a page that are
-generated with the table shortcode.
+generated with the table [shortcode][].
Here is an example page-level table configuration override which
emits a `has-text-weight-bold` class for all table cells with an
@@ -1317,7 +1316,7 @@ table_config:
Use the `table_config` parameter in the root `config.toml` to override
the table configuration for all tables across all pages on a site that
-are generated with the table shortcode.
+are generated with the table [shortcode][].
Here is an example overide for [Bootstrap][]:
@@ -1373,5 +1372,7 @@ Here is a full list of available table configuration properties:
"HyperText Markup Language"
[markdown]: https://en.wikipedia.org/wiki/Markdown
"Markdown markup language"
-[hugo-shortcode-table]: https://github.com/pablotron
+[shortcode]: https://gohugo.io/content-management/shortcodes/
+ "Hugo shortcode"
+[git]: https://github.com/pablotron/hugo-shortcode-table
"hugo-shortcode-table github repository"