ViMaSter/hackertours-theme
Watch
0
0
Fork
You've already forked hackertours-theme
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README for improved shortcodes.

Browse source
This commit is contained in:
Fredrik Jonsson 2023-01-05 10:27:51 +01:00
commit d2efd1ae4f
1 changed files with 13 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -492,15 +492,21 @@ podcast:
### Audio and Video ### Audio and Video
Support for files in global assets directory, static directory and page resources.
``` ```
{{< audio src="/audio/audio.mp3" class="something" >}} {{< audio src="/audio/audio.mp3" class="something" >}}
{{< video src="/video/video.mp4" class="something" >}} {{< video src="/video/video.mp4" poster="/images/poster.jpeg" class="something" >}}
``` ```
Possible parameters are: Possible parameters are:
* autoplay (only video)
* caption
* class * class
* loop (only video)
* poster (only video)
* preload (none/metadata/auto, default metadata) * preload (none/metadata/auto, default metadata)
* src * src
* width (only video) * width (only video)
@ -563,7 +569,7 @@ Possible parameters are:
### Figure and Img ### Figure and Img
Zen comes with a improved version of the built in "figure" shortcut and a very similar "img" shortcode. Support for images both in "assets" and in "static". Zen comes with a improved version of the built in "figure" shortcut and a very similar "img" shortcode. Support for images in global assets directory, static directory and page resources.
``` ```
{{< figure src="/images/image.jpg" alt="Example image." caption="Lorem ipsum dolor sit amet." >}} {{< figure src="/images/image.jpg" alt="Example image." caption="Lorem ipsum dolor sit amet." >}}
@ -581,14 +587,14 @@ Possible parameters are:
* class * class
* height * height
* link * link
* size (only works if image is inside /assets dir) * size (not for images in static directory)
* srcset (not for images in static directory)
* src * src
* title (only figure) * title (only figure)
* width * width
Only "src" is none optional but you really should set "alt" as well. Only "src" is none optional but you really should set "alt" as well.
* If the images is inside the /assets dir and "size" is set the shortcode will use the resize command.
* You can set a max width for images with parameter "imageMaxWidth". Only used for images where size, width and height is not set. * You can set a max width for images with parameter "imageMaxWidth". Only used for images where size, width and height is not set.
* If width and height is not set the real dimensions of the image will be used. * If width and height is not set the real dimensions of the image will be used.
* If only width or only height is set the other value will be proportionally calculated. * If only width or only height is set the other value will be proportionally calculated.
@ -596,7 +602,7 @@ Only "src" is none optional but you really should set "alt" as well.
### File ### File
Creates a link to a file in static or in assets directory. Creates a link to a file in global assets directory, static directory and page resources.
Possible parameters are: Possible parameters are:
@ -623,7 +629,7 @@ This will output:
### SVG ### SVG
SVG shortcode with inline support. Support for images both in "assets" and in "static". SVG shortcode with inline support. Support for images in global assets directory, static directory and page resources.
``` ```
{{< svg src="/images/image.svg" alt="Example image." caption="Lorem ipsum dolor sit amet." >}} {{< svg src="/images/image.svg" alt="Example image." caption="Lorem ipsum dolor sit amet." >}}
@ -637,6 +643,7 @@ Possible parameters are:
* caption * caption
* class * class
* height (not for inline) * height (not for inline)
* inline
* link * link
* src * src
* width (not for inline) * width (not for inline)