clarify README

This commit is contained in:
polv committed 2026-02-11 06:56:46 +07:00
1 parent 8434cf78ed
commit 3544c5c7c2
1 file changed
+5 -5
+5 -5
View File
@@ -25,7 +25,7 @@ pnpm run dev
This starts the VitePress development server and WebSocket server for communication. This starts the VitePress development server and WebSocket server for communication.
### Step 3: Use the Downloader Interface ### Step 3: Use the Web Interface to Process the Video
1. Open the VitePress website in your browser 1. Open the VitePress website in your browser
2. Enter your video filename in the textbox (e.g. `my video [abc123].mp4`, `presentation.webm`, `my-video [xyz].mpeg`) 2. Enter your video filename in the textbox (e.g. `my video [abc123].mp4`, `presentation.webm`, `my-video [xyz].mpeg`)
@@ -34,16 +34,16 @@ This starts the VitePress development server and WebSocket server for communicat
The app will: The app will:
- Load the markdown matching the submitted video filename. - Load the markdown matching the submitted video filename.
- If it exists: process the video — extract screenshots for timestamps, insert images, and save the markdown. - If it exists: process the video — extract screenshots for timestamps, insert images, and save the markdown.
- If it does not exist: create the markdown and exit. Edit the new file (add frontmatter or timestamps), then run the Downloader again. - If it does not exist: create the markdown and exit. Edit the new file (add frontmatter or timestamps), then run the web interface again to process the file.
#### Create/Edit the Markdown File #### Create/Edit the Markdown File
You may let the Downloader create the markdown file automatically, or create it yourself by placing a file in the `/docs` directory. The filename should match the video filename with any bracketed ID removed and spaces replaced with underscores, for example: You may let the web interface create the markdown file automatically, or create it yourself by placing a file in the `/docs` directory. The filename should match the video filename with any bracketed ID removed and spaces replaced with underscores, for example:
- Video file: `my video [abc123].mp4` → Markdown file: `my_video.md` - Video file: `my video [abc123].mp4` → Markdown file: `my_video.md`
- Video file: `presentation.webm` → Markdown file: `presentation.md` - Video file: `presentation.webm` → Markdown file: `presentation.md`
If the file is newly created by the Downloader, you will need to edit the markdown to provide the content or timestamps the app will use. After editing, run the Downloader again to regenerate screenshots and update image references. If the file is newly created by the web interface, you will need to edit the markdown to provide the content or timestamps the app will use. After editing, use the web interface again to process the file and regenerate screenshots.
The markdown file content can be one of the following: The markdown file content can be one of the following:
@@ -86,7 +86,7 @@ docs/ # VitePress documentation root
.vitepress/ .vitepress/
theme/ theme/
components/ components/
Downloader.vue # Vue component for the downloader interface Downloader.vue # Vue component for entering a video filename (web interface / video input UI)
Video.vue # Vue component to display videos and linked timestamps Video.vue # Vue component to display videos and linked timestamps
public/ # Directory to put downloaded videos public/ # Directory to put downloaded videos
*.md # Markdown files with content *.md # Markdown files with content