-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Daniel Boll <[email protected]>
- Loading branch information
1 parent
a58fef6
commit 4347d3d
Showing
2 changed files
with
73 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# VHS documentation | ||
# | ||
# Output: | ||
# Output <path>.gif Create a GIF output at the given <path> | ||
# Output <path>.mp4 Create an MP4 output at the given <path> | ||
# Output <path>.webm Create a WebM output at the given <path> | ||
# | ||
# Require: | ||
# Require <string> Ensure a program is on the $PATH to proceed | ||
# | ||
# Settings: | ||
# Set FontSize <number> Set the font size of the terminal | ||
# Set FontFamily <string> Set the font family of the terminal | ||
# Set Height <number> Set the height of the terminal | ||
# Set Width <number> Set the width of the terminal | ||
# Set LetterSpacing <float> Set the font letter spacing (tracking) | ||
# Set LineHeight <float> Set the font line height | ||
# Set LoopOffset <float>% Set the starting frame offset for the GIF loop | ||
# Set Theme <json|string> Set the theme of the terminal | ||
# Set Padding <number> Set the padding of the terminal | ||
# Set Framerate <number> Set the framerate of the recording | ||
# Set PlaybackSpeed <float> Set the playback speed of the recording | ||
# | ||
# Sleep: | ||
# Sleep <time> Sleep for a set amount of <time> in seconds | ||
# | ||
# Type: | ||
# Type[@<time>] "<characters>" Type <characters> into the terminal with a | ||
# <time> delay between each character | ||
# | ||
# Keys: | ||
# Backspace[@<time>] [number] Press the Backspace key | ||
# Down[@<time>] [number] Press the Down key | ||
# Enter[@<time>] [number] Press the Enter key | ||
# Space[@<time>] [number] Press the Space key | ||
# Tab[@<time>] [number] Press the Tab key | ||
# Left[@<time>] [number] Press the Left Arrow key | ||
# Right[@<time>] [number] Press the Right Arrow key | ||
# Up[@<time>] [number] Press the Up Arrow key | ||
# Down[@<time>] [number] Press the Down Arrow key | ||
# Ctrl+<key> Press the Control key + <key> (e.g. Ctrl+C) | ||
# | ||
# Display: | ||
# Hide Hide the subsequent commands from the output | ||
# Show Show the subsequent commands in the output | ||
|
||
Output demo.gif | ||
|
||
Require echo | ||
|
||
Set FontSize 28 | ||
Set Width 1080 | ||
Set Height 720 | ||
Set LoopOffset 50% | ||
|
||
Type "npm run start new project" Sleep 500ms Enter | ||
|
||
# Wait for the project build and run | ||
|
||
Sleep 4s | ||
|
||
Down 1 Sleep 500ms Enter | ||
|
||
Type "My awesome project" Sleep 500ms Enter | ||
|
||
Down 1 Sleep 500ms Enter | ||
|
||
Sleep 1s | ||
|
||
Down 1 Sleep 500ms | ||
Down 1 Sleep 500ms Enter Sleep 500ms | ||
|
||
Down 1 Sleep 1s |