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

github.com/cntrump/hugo-notepadium.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvvveiii <cntrump@gmail.com>2020-01-11 08:19:13 +0300
committervvveiii <cntrump@gmail.com>2020-01-11 08:19:13 +0300
commit6c8c12d540c589c1b63f64aa26e38ccf48c86c13 (patch)
treee5ddeb87c749b3ab3c4dced81b8a5c8674ddc78a /README.md
parentda3477a5ca03e21190a87ebef0235a54380fcbc8 (diff)
update ReadMe
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6318e7c..f13b3e1 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ Features
- Custom CSS/SASS/SCSS supporting
- Custom JS supporting
- Custom header right items supporting
+- Builtin `plist` shortcode for API document.
Preview the exampleSite:
@@ -308,6 +309,46 @@ Or, you can rewrite it:
![](https://raw.githubusercontent.com/cntrump/hugo-notepadium/master/images/04.png)
+### `plist` shortcode
+
+Syntax:
+
+```md
+{{< plist
+ "key1: value1"
+ "key2: value2"
+ "key3: value3"
+ ...
+ "keyN: valueN"
+>}}
+```
+
+Example:
+
+```md
+- `text-align`
+
+ ```css
+ .box {
+ text-align: center;
+ }
+ ```
+
+ Definition and Usage
+
+ The `text-align` property specifies the horizontal alignment of text in an element.
+
+ {{< plist
+ "Default value: `left` if direction is ltr, and `right` if direction is rtl"
+ "Inherited: yes"
+ "Animatable: no. Read about animatable"
+ "Version: CSS1"
+ "JavaScript syntax: `object.style.textAlign=\"right\"`"
+ >}}
+```
+
+![](https://raw.githubusercontent.com/cntrump/hugo-notepadium/master/images/05.png)
+
## Thanks
- [**Hugo**](https://gohugo.io/)