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

github.com/zzossig/hugo-theme-zdoc.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzzossig <zzossig@gmail.com>2020-03-16 08:29:48 +0300
committerzzossig <zzossig@gmail.com>2020-03-16 08:29:48 +0300
commitcf1c87100cec3f1f163cbb75487fb1601edd4563 (patch)
tree45d3187ebb73b92a936a1b746e63bbe3a93f3759 /README.md
parent8cdd6df08e300fa1116ae18f57512fb11d90ae49 (diff)
alert, notice shortcode added
#20
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index 09a5e96..cd6f8ba 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ Thank you for click me!. Zdoc theme is a simple documentation theme powered by H
* [How to make Doc](#how-to-make-doc)
* [Multi Language](#multi-language)
* [Favicon](#favicon)
+* [Shortcodes](#shortcodes)
## Features
@@ -355,4 +356,28 @@ If you want to support mobile favicon, use [favicon-generator](https://www.favic
- Make favicons from favicon-generator site.
- Make a folder at `root/static/favicon`
- Unzip the generated favicon to that folder.
-- Set the config param `useFaviconGenerator` to `true` \ No newline at end of file
+- Set the config param `useFaviconGenerator` to `true`
+
+## Shortcodes
+
+### alert
+
+```bash
+{{< alert theme="warning" >}} # warning, success, info, danger
+**this** is a text
+{{< /alert >}}
+```
+
+### expand
+
+```bash
+{{< expand "Expand me" >}}Some Markdown Contents{{< /expand >}}
+```
+
+### notice
+
+```bash
+{{< notice success "This is title" >}} # success, info, warning, error
+success
+{{< /notice >}}
+```