Skip to content
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.

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

[Migration tooling] Images #111

Closed
bmorelli25 opened this issue Dec 17, 2024 · 2 comments
Closed

[Migration tooling] Images #111

bmorelli25 opened this issue Dec 17, 2024 · 2 comments
Labels
authoring Relates to our markdown parser

Comments

@bmorelli25
Copy link
Member

Block Image

A block image is converted to MyST image block directive:

```{image} <image_uri>
:alt: <alt_text>
:class: <classes>
```

Inline Image

An inline image is converted to MyST inline image directive:

![<alt_text>]<image_uri>
@bmorelli25 bmorelli25 added the authoring Relates to our markdown parser label Dec 17, 2024
@Mpdreamz
Copy link
Member

We support inline images through:

![<alt_text>](<image_uri>)

Note the parentheses which are required in docs-builder as per common mark specs

@bmorelli25 @siamakp-elastic do we have a few examples of where these are uses in our existing documentation?

@bmorelli25
Copy link
Member Author

Resolved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authoring Relates to our markdown parser
Projects
None yet
Development

No branches or pull requests

2 participants