Browse Source

docs(feature/post-images): add note about hiding captions via param

Josh Habdas 10 months ago
parent
commit
232b038261
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74
1 changed files with 15 additions and 1 deletions
  1. 15
    1
      docs/content/feature/post-images.md

+ 15
- 1
docs/content/feature/post-images.md View File

@@ -67,7 +67,7 @@ Figure captions are generated automatically when `description` and/or `creator`
67 67
     sameas = "https://unsplash.com/photos/NqOInJ-ttqM/ottawa-road-in-the-evening"
68 68
 ```
69 69
 
70
-Override automatic captions using `caption` in addition to any other metadata:
70
+Override automatic caption using `caption` metadata:
71 71
 
72 72
 ```toml
73 73
 [[resources]]
@@ -81,4 +81,18 @@ Override automatic captions using `caption` in addition to any other metadata:
81 81
     keywords = ["light trail", "building", "speed", "night"]
82 82
 ```
83 83
 
84
+Hide captions while retaining structured data with `hide_caption` param:
85
+
86
+```toml
87
+[[resources]]
88
+  src = "images/**291607**.jpg"
89
+  name = "header"
90
+  [resources.params]
91
+    hide_caption = true
92
+  [resources.params.meta]
93
+    creator = "Marc-Olivier Jodoin"
94
+    sameas = "https://unsplash.com/photos/NqOInJ-ttqM/ottawa-road-in-the-evening"
95
+    contentlocation = "Ottawa, Canada"
96
+```
97
+
84 98
 All available metadata provided in examples above.

Loading…
Cancel
Save