Skip to content

Commit 4b86666

Browse files
authored
Add doc pointers to the embed_video shortcode (#1549)
1 parent dd1e025 commit 4b86666

File tree

3 files changed

+30
-7
lines changed

3 files changed

+30
-7
lines changed

.github/newsletter-issue-template.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,9 @@ but here are the most important rules:
102102
- Only one image per section is allowed.
103103
- The maximum size is 300kb for static images and 2.5mb for GIFs.
104104
- The image should come before the text, and must have alt text for accessibility.
105-
- Prefer static images to GIFs, to keep the page load times down.
105+
- Prefer static images to GIFs/videos, to keep the page load times down.
106+
- To include a video, encode it as `H.264` in an `mp4` container and use
107+
the `embed_video()` shortcode; videos autoplay in a loop (muted).
106108
- Each section should be under 1000 characters, and under 6 paragraphs.
107109
- This only applies to the rendered text, not the markup.
108110
- Keep formatting minimal - no bold/italics/etc.
@@ -120,6 +122,10 @@ Please use these templates as a starting point:
120122
src="img"
121123
caption="optional image label") }}
122124

125+
OR
126+
127+
{{ embed_video(type="video/mp4", src="my-video.mp4", caption="optional video caption") }}
128+
123129
[Game name] ([GitHub], [Discord], [Twitter]) by [@nickname]
124130
is... {short project description in one sentence}.
125131

@@ -140,6 +146,10 @@ _Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
140146
src="img"
141147
caption="optional image label") }}
142148

149+
OR
150+
151+
{{ embed_video(type="video/mp4", src="my-video.mp4", caption="optional video caption") }}
152+
143153
[@nickname] published an [article] about...
144154
{overview what the resource is about}.
145155

.github/newsletter-template.md

+4
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ Ideal section structure is:
5555
src="image link"
5656
caption="image caption") }}
5757
58+
OR
59+
60+
{{ embed_video(type="video/mp4", src="my-video.mp4", caption="optional video caption") }}
61+
5862
A paragraph or two with a summary and [useful links].
5963
6064
_Discussions:

CONTRIBUTING.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22

33
Thank you for contributing to the newsletter! 💖
44

5-
- [Writing Newsletter Sections](#writing-newsletter-sections)
6-
- [Templates](#templates)
7-
- [Style Guidelines](#style-guidelines)
8-
- [Becoming an Editor](#becoming-an-editor)
5+
- [Contributing Guide](#contributing-guide)
6+
- [Writing Newsletter Sections](#writing-newsletter-sections)
7+
- [Templates](#templates)
8+
- [Games, Apps or Libraries](#games-apps-or-libraries)
9+
- [Articles, Blog Posts or Videos](#articles-blog-posts-or-videos)
10+
- [Style Guidelines](#style-guidelines)
11+
- [Becoming an Editor](#becoming-an-editor)
912

1013
## Writing Newsletter Sections
1114

@@ -78,6 +81,10 @@ _Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
7881
src="img"
7982
caption="optional image label") }}
8083

84+
OR
85+
86+
{{ embed_video(type="video/mp4", src="my-video.mp4", caption="optional video caption") }}
87+
8188
[@nickname] published an [article] about...
8289
{overview what the resource is about}.
8390

@@ -100,11 +107,13 @@ _Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
100107
- Avoid having multiple/nested bullet points.
101108
- This guideline may be relaxed if your project has multiple parts that
102109
aren't independent enough for their own sections.
103-
- Only include one image (<300kb) or GIF (<2.5mb).
110+
- Only include one image (<300kb), GIF (<2.5mb) or video (<2.5mb).
104111
- Images should be placed before text, with an optional caption and
105112
mandatory alternate text for accessibility.
106113
- Unless essential to demonstrating your project, prefer static images
107-
over GIFs, to keep the file size down.
114+
over GIFs/videos, to keep the file size down.
115+
- To include a video, encode it as `H.264` in an `mp4` container and use
116+
the `embed_video()` shortcode; videos autoplay in a loop (muted).
108117
- Use singular 'they' if you’re not sure what someone's pronouns are.
109118
- If a project has been featured in previous newsletters, try to focus on
110119
what's new rather than repeating previous content.

0 commit comments

Comments
 (0)