Skip to content

Clarify image paths for nested assets #7158

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

Open
hamedrabah wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify image paths for nested assets #7158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions create/image-embeds.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,19 @@ Use [Markdown syntax](https://www.markdownguide.org/basic-syntax/#images) to add

Image paths are root-relative from your docs repository. For example, if your image is at `images/screenshot.png` in your repository, the path is `/images/screenshot.png`. Relative paths (for example, `./screenshot.png`) are not supported.

You can store images in any directory, including an `assets` folder beside related pages. The path in MDX must still start at the repository root:

```text
/your-project
|- docs.json
|- guides/
|- setup.mdx
|- assets/
|- setup-dialog.png
```

Reference the image from any page with `/guides/assets/setup-dialog.png`. You do not need a global image-directory setting.

<Tip>
Always include descriptive alt text to improve accessibility and SEO. The alt text should clearly describe what the image shows.
</Tip>
Expand Down