Skip to content

Commit 2ddbd82

Browse files
committed
Add doc pointers to the embed_video shortcode
I'm not particularly attached to H.264 but it's a codec that works well on many popular platforms.
1 parent 1a92c46 commit 2ddbd82

File tree

3 files changed

+30
-7
lines changed

3 files changed

+30
-7
lines changed

Diff for: .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.
@@ -118,6 +120,10 @@ Please use these templates as a starting point:
118120
![alt text](img)
119121
_optional image label_
120122

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

@@ -136,6 +142,10 @@ _Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
136142
![alt text](img)
137143
_optional image label_
138144

145+
OR
146+
147+
{{ embed_video(type="video/mp4", src="my-video.mp4", caption="optional video caption") }}
148+
139149
[@nickname] published an [article] about...
140150
{overview what the resource is about}.
141151

Diff for: .github/newsletter-template.md

+4
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ Ideal section structure is:
5353
![image/GIF description](image link)
5454
_image caption_
5555
56+
OR
57+
58+
{{ embed_video(type="video/mp4", src="my-video.mp4", caption="optional video caption") }}
59+
5660
A paragraph or two with a summary and [useful links].
5761
5862
_Discussions:

Diff for: 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

@@ -74,6 +77,10 @@ _Discussions: [/r/rust_gamedev](link), [Twitter](link), [etc](link)_
7477
![alt text](img)
7578
_optional image label_
7679

80+
OR
81+
82+
{{ embed_video(type="video/mp4", src="my-video.mp4", caption="optional video caption") }}
83+
7784
[@nickname] published an [article] about...
7885
{overview what the resource is about}.
7986

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

0 commit comments

Comments
 (0)