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.

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

Docs: Add video-embed shortcode to Shortcode page #1048

Merged
merged 5 commits into from
Feb 14, 2025
Merged

Docs: Add video-embed shortcode to Shortcode page #1048

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d3bc6ed
Added video-embed shortcode to shortcode page
imatwawana Feb 13, 2025
6a6b130
Edited wording
imatwawana Feb 13, 2025
551320c
Updated What's new
imatwawana Feb 13, 2025
4d47f96
Updated link
imatwawana Feb 13, 2025
9e76849
Apply suggestions from code review
imatwawana Feb 14, 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
1 change: 1 addition & 0 deletions docs/sources/whats-new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ This page provides a summary of notable changes to Writers' Toolkit guidance.
| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Fixed the path to the section template file. | https://raw.githubusercontent.com/grafana/writers-toolkit/refs/heads/main/docs/static/templates/section-template.md |
| Added `topic/<TYPE>` Make targets to create a topic from its template | [Topic types](/docs/writers-toolkit/structure/topic-types/) |
| Added `video-embed` to Shortcodes page. | [Shortcodes](/docs/writers-toolkit/write/shortcodes/#video-embed) |

## January 2025

Expand Down
11 changes: 11 additions & 0 deletions docs/sources/write/shortcodes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1194,6 +1194,17 @@ Produces:

{{< translate "docs_feedback_heading" >}}

## Video-embed

The `video-embed` shortcode embeds videos on the page.
Use `.mp4` files of 10 MB or smaller.

The shortcode requires a single parameter, the `src`, to set the source of the image. For this, use the path to the recording file:

```
{{</* video-embed src="<PATH>" */>}}
```

## Vimeo

The `vimeo` shortcode embeds videos hosted on vimeo.com.
Expand Down