aboutsummaryrefslogtreecommitdiff
path: root/content/overview-showdata.md
diff options
context:
space:
mode:
Diffstat (limited to 'content/overview-showdata.md')
-rw-r--r--content/overview-showdata.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/content/overview-showdata.md b/content/overview-showdata.md
new file mode 100644
index 0000000..90e4406
--- /dev/null
+++ b/content/overview-showdata.md
@@ -0,0 +1,29 @@
++++
+title = "Showdata Shortcode"
+description = "A brief description of a custom Shortcode for Zola that implements loading and displaying external data."
+date = 2021-05-04
+draft = false
+
+[taxonomies]
+tags = ["Features","Data","Shortcodes"]
+[extra]
+keywords = "Data, Load, External, Shortcodes"
++++
+
+The `showdata` shortcode can load and display data from an external source via Zola's [load_data()](https://www.getzola.org/documentation/templates/overview/#load-data) function.
+
+<!-- more -->
+
+These are the parameters, currently all 3 are required.
+
+- `src` path or url to file (if url, must include the http(s):// prefix).
+- `type` the type of file to load. ([supported types](https://www.getzola.org/documentation/templates/overview/#load-data))
+- `key` the field in the data that you want to display.
+
+### Usage
+
+This theme requires version &#123;&#123; showdata(src="https://raw.githubusercontent.com/Jieiku/abridge/master/theme.toml" type="toml" key="min_version") &#125;&#125; or later of Zola.
+
+### Output
+
+This theme requires version {{ showdata(src="https://raw.githubusercontent.com/Jieiku/abridge/master/theme.toml" type="toml" key="min_version") }} or later of Zola.