Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/kc0bfv/ticky_tacky_dark.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl <kc0bfv@gmail.com>2020-01-19 06:33:42 +0300
committerKarl <kc0bfv@gmail.com>2020-01-19 06:33:42 +0300
commit1d7b038c3b2c5c9764b1f1f0217a659b90e50699 (patch)
treead3b459a47a94f724a68f8576f863ce0f673f412
parent0c27151f6a76d45be496442ec995e5e33d11787a (diff)
Explain shortcode in Readme
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 038cdab..de332ba 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,24 @@ On sub-pages, images can appear on the left side. Sizing can vary there, but at
Header images are, optimally, 950x200 pixels. Specify these in the site configuration as a list of image URLs with option `headerimages`. One will be randomly selected on page load.
+## Custom Shortcode
+
+### Dropdown Text
+
+To add a link that, when clicked, drops-down a section of text, use shortcode `dropdown/link` and shortcode `dropdown/content`.
+
+**Example**
+
+```
+{{< dropdown/link togglename="dropNum1" linktext="Click here to see the text that will drop down." >}}
+```
+
+```
+{{< dropdown/content togglename="dropNum1" >}}
+ This is the text that drops down when you click the link.
+{{< /dropdown/content >}}
+```
+
## Usage
Put this theme in your site's themes folder, then modify the site config to specify the theme `ticky_tacky_tark`, or use the `-t ticky_tacky_dark` command line switch.