summaryrefslogtreecommitdiff
path: root/docs/modules
diff options
context:
space:
mode:
authorDan Allen <dan.j.allen@gmail.com>2022-06-16 01:52:36 -0600
committerDan Allen <dan.j.allen@gmail.com>2022-06-16 01:52:36 -0600
commitdb8cf5bb60652f37a8506aec8ab82af10b7492bc (patch)
treeac5a7d5e3870ab9c6ce2d81932dd8430fc087086 /docs/modules
parentf92b04bd95ca28ec542630d399630a6c87139454 (diff)
document that {page-layout} can be used in path of background image for running content
Diffstat (limited to 'docs/modules')
-rw-r--r--docs/modules/theme/pages/images.adoc13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/modules/theme/pages/images.adoc b/docs/modules/theme/pages/images.adoc
index 5f09f85a..3d630bf0 100644
--- a/docs/modules/theme/pages/images.adoc
+++ b/docs/modules/theme/pages/images.adoc
@@ -56,6 +56,19 @@ title-page:
background-image: image:{docdir}/images/title-cover.png[]
----
+=== Per page layout
+
+When defining the background image for running content, you can configure the image to be selected per page layout by including the `+{page-layout}+` attribute reference in the image path.
+
+[,yaml]
+----
+footer:
+ background-image: image:footer-bg-{page-layout}.png[]
+----
+
+The image is resolved once per page layout that's encountered in the document.
+Using this technique requires that the page layout value be included in the path of the image (e.g., footer-bg-landscape.png).
+
[#attributes]
=== Fit, width, and position