Add image section to markdown cheatsheet page

pulp · Jan 17, 2025 · b5ecdff · b5ecdff
1 parent b3d325c
commit b5ecdff
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/docs/dev/reference/markdown-cheatsheet.md b/docs/dev/reference/markdown-cheatsheet.md
@@ -131,6 +131,36 @@ pulp file repository update --name myrepo --retained-versions 1
 ```
 ````
 
+### Images
+
+The image paths can be relative or absolute:
+
+Simple:
+
+```
+# Relative path. Image is in the same folder
+![OperatorHub tab](1.png "Pulp on OperatorHub tab")
+
+# Absolute path. Specify the path with 'site:'
+![Pulp 101](site:pulpcore/docs/assets/images/pulp-101.png)
+```
+
+With subtitle:
+
+```
+# Subtitle on top
+<figure markdown="span">
+  <figcaption>Find Pulp  at `OperatorHub > Integration & Delivery`.</figcaption>
+  ![OperatorHub tab](1.png "Pulp on OperatorHub tab")
+</figure>
+
+# Subtitle at bottom
+<figure markdown="span">
+  <figcaption>Find Pulp  at `OperatorHub > Integration & Delivery`.</figcaption>
+  ![OperatorHub tab](1.png "Pulp on OperatorHub tab")
+</figure>
+```
+
 ### Admonitions
 
 [See mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types)