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

github.com/onweru/newsroom.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorweru <onewesh@gmail.com>2020-04-30 21:08:56 +0300
committerweru <onewesh@gmail.com>2020-04-30 21:08:56 +0300
commit057d966c8d5d4c52c81b0f4fceca6c1347e610e6 (patch)
tree4fc750f402e628eb099e90562aafc425ad4cc5fe
parent8d4989bee5b96bdc3ba1f7cf8b663555bf9ad143 (diff)
update docs
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index a3b68bb..564703b 100644
--- a/README.md
+++ b/README.md
@@ -82,9 +82,34 @@ From your disqus dashboard, set your scripts `color scheme` to __auto__. See scr
![](https://github.com/onweru/newsroom/blob/master/images/disqus-color-scheme.png)
+## Custom Shortcodes
+
+This theme ships with two custom shortcodes (they both use positional parameters):
+
+1. __Video__
+ This shortcode can be used to embed a youtube video with custom styling. It takes a solo positional parameter.
+
+ ```
+ ...
+ {{< video "youtubeVideoID" >}}
+ ...
+ ```
+
+2. __Picture__
+ You want to use darkmode images when darkmode is enabled on a device and a regular image on lightmode? It takes 3 positional parameter
+
+ Store these images in the `static/images` directory.
+
+ ```
+ ...
+ {{< picture "lightModeImage.png" "darkModeImage.png" "Image alt text" >}}
+ ...
+ ```
+
## From the same creator
-[Swift Theme](https://github.com/onweru/hugo-swift-theme)
+1. [Swift Theme](https://github.com/onweru/hugo-swift-theme)
+2. [Compose Theme](https://github.com/onweru/compose)
## License