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

clarify id instructions #712

Merged
merged 1 commit into from
Dec 12, 2023
Merged
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion content/docs-v1/figure-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Figures and all their associated attributes should be listed in the `figures.yam
src: "portrait-of-still.jpg"
```

The `id` is an assigned value that is used to reference the image when using a shortcode. The `id` can be anything as long as it is **all lowercase with no spaces**. You can separate words through the use of dashes (-), as in the two examples above. The use of uppercase letters, periods, spaces, or underscores will cause the preview to break. It is helpful to keep the `id` short, otherwise adding shortcodes can become cumbersome.
The `id` is an assigned value that is used to reference the image when using a shortcode. The `id` can be anything as long as it **starts with a letter, is all lowercase, and uses dashes instead of spaces**. See examples of valid `id`'s above. An `id` that starts with a number or uses uppercase letters, periods, spaces, or underscores will result in a broken preview. It is helpful to keep the `id` short to prevent cumbersome shortcodes.

The `src` points to where you have saved your image, with the default being `/_assets/images` unless otherwise noted in the `config.yaml`. You can also create subfolders in the `/_assets/images` directory which then need to be included in the `src`. For example, if you created a folder inside the `/_assets/images` directory called "catalogue" and put the `portrait-of-still.jpg` image in that folder, then the `src` would be `catalogue/portrait-of-still.jpg`.

Expand Down