Skip to content

Update syntax image examples to use images path #1162

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 1, 2025
Merged

Update syntax image examples to use images path #1162

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fccc98d
Update docs to use `images` path
kilfoyle Apr 21, 2025
4d81fdf
Update image locations
kilfoyle Apr 28, 2025
e2e8264
fix build errors and hints
colleenmcginnis Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/syntax/images.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,21 @@
## Block-level images

```markdown
![APM](img/apm.png)
![APM](images/apm.png)
```

![APM](img/apm.png)
![APM](images/apm.png)

Check failure on line 15 in docs/syntax/images.md

View workflow job for this annotation

GitHub Actions / build 

`images/apm.png` does not exist. resolved to `/home/runner/work/docs-builder/docs-builder/docs/syntax/images/apm.png

Or, use the `image` directive.

```markdown
:::{image} img/observability.png
:::{image} images/observability.png
:alt: Elasticsearch
:width: 250px
:::
```

:::{image} img/observability.png
:::{image} images/observability.png

Check failure on line 26 in docs/syntax/images.md

View workflow job for this annotation

GitHub Actions / build 

`images/observability.png` does not exist. resolved to `/home/runner/work/docs-builder/docs-builder/docs/syntax/images/observability.png
:alt: Elasticsearch
:width: 250px
:::
Expand All @@ -33,36 +33,36 @@
Screenshots are images displayed with a box-shadow. Define a screenshot by adding the `:screenshot:` attribute to a block-level image directive.

```markdown
:::{image} img/apm.png
:::{image} images/apm.png
:screenshot:
:::
```

:::{image} img/apm.png
:::{image} images/apm.png

Check failure on line 41 in docs/syntax/images.md

View workflow job for this annotation

GitHub Actions / build 

`images/apm.png` does not exist. resolved to `/home/runner/work/docs-builder/docs-builder/docs/syntax/images/apm.png
:screenshot:
:::

## Inline images

```markdown
Here is the same image used inline ![Elasticsearch](img/observability.png "elasticsearch =50%x50%")
Here is the same image used inline ![Elasticsearch](images/observability.png "elasticsearch =50%x50%")
```

Here is the same image used inline ![Elasticsearch](img/observability.png "elasticsearch =50%x50%")
Here is the same image used inline ![Elasticsearch](images/observability.png "elasticsearch =50%x50%")

Check failure on line 51 in docs/syntax/images.md

View workflow job for this annotation

GitHub Actions / build 

`images/observability.png` does not exist. resolved to `/home/runner/work/docs-builder/docs-builder/docs/syntax/images/observability.png


### Inline image titles

Titles are optional making this the minimal syntax required

```markdown
![Elasticsearch](img/observability.png)
![Elasticsearch](images/observability.png)
```

Including a title can be done by supplying it as an optional argument.

```markdown
![Elasticsearch](img/observability.png "elasticsearch")
![Elasticsearch](images/observability.png "elasticsearch")
```

### Inline image sizing
Expand Down Expand Up @@ -92,16 +92,16 @@
### SVG

```markdown
![Elasticsearch](img/alerts.svg)
![Elasticsearch](images/alerts.svg)
```
![Elasticsearch](img/alerts.svg)
![Elasticsearch](images/alerts.svg)

Check failure on line 97 in docs/syntax/images.md

View workflow job for this annotation

GitHub Actions / build 

`images/alerts.svg` does not exist. resolved to `/home/runner/work/docs-builder/docs-builder/docs/syntax/images/alerts.svg

### GIF

```markdown
![Elasticsearch](img/timeslider.gif)
![Elasticsearch](images/timeslider.gif)
```
![Elasticsearch](img/timeslider.gif)
![Elasticsearch](images/timeslider.gif)

Check failure on line 104 in docs/syntax/images.md

View workflow job for this annotation

GitHub Actions / build 

`images/timeslider.gif` does not exist. resolved to `/home/runner/work/docs-builder/docs-builder/docs/syntax/images/timeslider.gif


## Asciidoc syntax
Expand All @@ -113,4 +113,4 @@

```asciidoc
image::images/synthetics-get-started-projects.png[]
```
```
Loading