gitpitch/docs/videos/widget.md

51 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2020-09-29 14:45:10 +08:00
# Video Widget
?> GitPitch widgets greatly enhance traditional markdown rendering capabilities for slide decks.
The video widget extends traditional markdown image syntax with support for displaying, positioning, sizing, transforming, and filtering video content.
### Widget Paths
All paths to video content specified within [PITCHME.md](/conventions/pitchme-md.md) markdown must be absolute paths to video content hosted on video streaming CDNs such as YouTube or Vimeo.
### Widget Syntax
The following markdown snippet demonstrates video widget syntax:
```markdown
![properties...](https://absolute/path/to/video)
```
?> The `properties...` list expects a comma-separated list of property `key=value` pairs.
### Video Properties
The video widget supports the following video specific properties:
[Video Widget Properties](../_snippets/video-widget-properties.md ':include')
### Grid Native Props
The *Video Widget* is a [grid native widget](/grid-layouts/native-widgets.md) meaning it also directly supports [grid layouts](/grid-layouts/) properties:
[Grid Widget Properties](../_snippets/grid-widget-properties.md ':include')
### YouTube
The following slide demonstrates a YouTube video rendered using video widget syntax. The markdown snippet used to create this slide takes advantage of numerous *grid native properties* to position, size, and transform the video on the slide:
![Sample slide demonstrating video widget for YouTube](../_images/gitpitch-videos-youtube.png)
### Vimeo
The following slide demonstrates a Vimeo video rendered using video widget syntax. The markdown snippet used to create this slide takes advantage of numerous *grid native properties* to position, size, and transform the video on the slide:
![Sample slide demonstrating video widget for Vimeo](../_images/gitpitch-videos-vimeo.png)
### MP4 Video
The following slide demonstrates an MP4 video rendered using video widget syntax. The markdown snippet used to create this slide takes advantage of numerous *grid native properties* to position, size, and transform the video on the slide:
![Sample slide demonstrating video widget for MP4](../_images/gitpitch-videos-mp4.png)