Skip to content

Commit 3d71a51

Browse files
committed
Add image section to markdown cheatsheet page
1 parent b96fcaf commit 3d71a51

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/dev/reference/markdown-cheatsheet.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,36 @@ pulp file repository update --name myrepo --retained-versions 1
131131
```
132132
````
133133

134+
### Images
135+
136+
The image paths can be relative or absolute:
137+
138+
Simple:
139+
140+
```markdown
141+
# Relative path. Image is in the same folder
142+
![OperatorHub tab](1.png "Pulp on OperatorHub tab")
143+
144+
# Absolute path. Specify the path with 'site:'
145+
![Pulp 101](site:pulpcore/docs/assets/images/pulp-101.png)
146+
```
147+
148+
With subtitle:
149+
150+
```markdown
151+
# Subtitle on top
152+
<figure markdown="span">
153+
<figcaption>Find Pulp at `OperatorHub > Integration & Delivery`.</figcaption>
154+
![OperatorHub tab](1.png "Pulp on OperatorHub tab")
155+
</figure>
156+
157+
# Subtitle at bottom
158+
<figure markdown="span">
159+
![OperatorHub tab](1.png "Pulp on OperatorHub tab")
160+
<figcaption>Find Pulp at `OperatorHub > Integration & Delivery`.</figcaption>
161+
</figure>
162+
```
163+
134164
### Admonitions
135165

136166
[See mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types)

0 commit comments

Comments
 (0)