From 1974d30be0b1e5c4312353a745d0746e4c8aeb9e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Radek=20Kozie=C5=82?= Date: Thu, 13 Dec 2018 16:18:29 +0100 Subject: [PATCH] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 37b3977..abd9a0e 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,13 @@ This theme is pretty basic and covers all of the essentials. All you have to do - an easy way to modify the theme (**Webpack, NodeJS, PostCSS** — initial setup created by [Marcin Dziewulski](http://www.mobily.pl)) - fully responsive +#### Built-in shortcodes + +- **`image`** (prop required: **`src`**; props optional: **`alt`**, **`position`** (**left** is default | center | right), **`style`**) + - eg: `{{< image src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" >}}` +- **`figure`** (same as `image`, plus few optional props: **`caption`**, **`captionPosition`** (left | **center** is default | right), **`captionStyle`** + - eg: `{{< figure src="/img/hello.png" alt="Hello Friend" position="center" style="border-radius: 8px;" caption="Hello Friend!" captionPosition="right" captionStyle="color: red;" >}}` + #### Code highlighting By default the theme is using PrismJS to color your code syntax. All you need to do is to wrap you code like this: