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.

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 wxt init demo GIF #974

Merged
merged 37 commits into from
Sep 14, 2024
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
824053b
docs: 📝 Add demo gif to installation guide
okineadev Sep 9, 2024
38d72dd
fix: 🩹 Remove `branch` property
okineadev Sep 9, 2024
42553da
feat: Added the ability to manually start the workflow
okineadev Sep 9, 2024
cbfd184
fix: Try this fix
okineadev Sep 9, 2024
334a95e
Okay
okineadev Sep 9, 2024
2687bf0
Not okay
okineadev Sep 9, 2024
62f7902
Try again
okineadev Sep 9, 2024
720a233
fix: 🛠️ Fixed falling workflow
okineadev Sep 9, 2024
e119d00
Update vhs.yml
okineadev Sep 9, 2024
415cd49
chore: Changed FPS in `demo.tape` to `50` and added note with reason
okineadev Sep 9, 2024
404038f
hello sigma
okineadev Sep 9, 2024
df758f0
docs: Added comments in `demo.tape`
okineadev Sep 9, 2024
0669add
fix: Fix file pattern
okineadev Sep 9, 2024
c041889
docs: Update comment
okineadev Sep 9, 2024
d187375
fix: Fix file pattern
okineadev Sep 9, 2024
a8a96e1
Test workflow
okineadev Sep 9, 2024
e934771
Update generated VHS GIF
actions-user Sep 9, 2024
4a13c4e
fix: Temporarily disabled function with installation of dependencies …
okineadev Sep 9, 2024
fce9b5f
docs: Add comment
okineadev Sep 9, 2024
245ebc9
Update generated VHS GIF
actions-user Sep 9, 2024
6da3207
skibidi dob dob dob yes yes
okineadev Sep 12, 2024
e8b2c34
Update docs/tapes/demo.tape
okineadev Sep 12, 2024
125e5fb
Update .github/workflows/vhs.yml
okineadev Sep 12, 2024
679d3af
Update docs/tapes/demo.tape
okineadev Sep 12, 2024
633169a
Update docs/get-started/installation.md
okineadev Sep 12, 2024
272797a
Delete docs/public/demo.gif
okineadev Sep 12, 2024
9cb1923
Update demo.tape
okineadev Sep 12, 2024
42bf77a
fix: Fix path
okineadev Sep 12, 2024
38b18ef
Test demo.tape
okineadev Sep 12, 2024
55e45a8
docs: Update `wxt init` GIF
okineadev Sep 12, 2024
0992db4
Try to fix vhs tape
okineadev Sep 13, 2024
3c6a3f7
docs: Update `wxt init` GIF
okineadev Sep 13, 2024
e99b7ec
Update vhs.yml
okineadev Sep 13, 2024
f99d524
Update demo.tape
okineadev Sep 13, 2024
ac6787c
docs: Update `wxt init` GIF
okineadev Sep 13, 2024
d14ad6a
Final tweaks
aklinker1 Sep 14, 2024
c6a282c
docs: Update `wxt init` GIF
aklinker1 Sep 14, 2024
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
44 changes: 44 additions & 0 deletions .github/workflows/vhs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: vhs
on:
push:
paths:
- 'docs/tapes/*.tape'
workflow_dispatch:

jobs:
vhs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup pnpm
uses: pnpm/[email protected]
with:
run_install: false

- name: Install Node.js
uses: actions/[email protected]
with:
node-version: 20
cache: 'pnpm'

# NOTE: This function does not work, possibly because `pnpm` is running in the vhs sandbox
# - name: Install dependencies
# run: pnpm store add wxt@latest

- uses: charmbracelet/[email protected]
with:
path: 'docs/tapes/demo.tape'

- uses: stefanzweifel/git-auto-commit-action@v4
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
commit_message: Update generated VHS GIF
commit_user_name: vhs-action 📼
commit_user_email: [email protected]
commit_author: vhs-action 📼 <[email protected]>
branch: ${{ github.head_ref || github.ref_name }}
# https://github.com/charmbracelet/vhs#output
file_pattern: 'docs/public/*.gif'
4 changes: 4 additions & 0 deletions docs/get-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ npx wxt@latest init <project-name>
npx wxt@latest init <project-name>
```

### Demo

![Demo](/public/demo.gif)

:::

There are several starting templates available.
Expand Down
Binary file added docs/public/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions docs/tapes/demo.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# VHS documentation
#
# You can view all VHS documentation on the command line with `vhs manual`.
# Or see https://github.com/charmbracelet/vhs#vhs-command-reference

# Output file
Output docs/public/demo.gif

# The tools we will use
Require pnpm


# === Scene ====
Set Width 1400
Set Height 800

# The maximum FPS for GIF is `50` FPS.
Set Framerate 50

# Terminal theme with WXT brand colors (which was taken from the website)
# Based on the standard charmbracelet/vhs theme:
# https://github.com/charmbracelet/vhs/blob/88e634f4a10bbe305b6aea9a12b4d8dc3dd7f31c/style.go#L7-L28
Set Theme {"background": "#1a1b1a", "foreground": "#dddddd", "black": "#282a2e", "brightBlack": "#4d4d4d", "red": "#D74E6F", "brightRed": "#FE5F86", "green": "#67d45e", "brightGreen": "#67d45e", "yellow": "#D3E561", "brightYellow": "#EBFF71", "blue": "#8056FF", "brightBlue": "#9B79FF", "magenta": "#ED61D7", "brightMagenta": "#FF7AEA", "cyan": "#04D7D7", "brightCyan": "#00FEFE", "white": "#bfbfbf", "brightWhite": "#e6e6e6", "indigo": "#5B56E0"}
Set FontSize 32

# Terminal settings
Set Shell "bash"

# Terminal prompt. It looks like "● mycommand ..."
Env PS1 "\e[0;32m●\e[0m "


# ===== Preparation =====
# Steps to prepare the recording environment, ensuring a clean and isolated setup.

Hide
# Create a temporary folder for demo
Type 'vhs_sandbox="$(mktemp -d)"' Enter
Type 'cd "$vhs_sandbox"' Enter
Type 'clear' Enter
Show


# ===== Actions =====

Type 'pnpm dlx wxt@latest init .' Sleep 1s Enter
Sleep 3.25s
Down@750ms Enter@750ms # Select `vue` template
Sleep 1.25s
Down@750ms Enter@750ms # Select `pnpm` as a package manager
Sleep 5s


# ===== Cleaning =====

Hide
# Delete the temporary folder
Type 'rm -rf "$vhs_sandbox"' Enter
Show