Skip to content

Set more user-friendly command names and add some user guide #36

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.

Sign up for GitHub

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

Open
GeekSquirrel wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Set more user-friendly command names and add some user guide #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cffd71e
set more user-friendly commnad names
GeekSquirrel Mar 11, 2023
f063aef
add basic usage and explain the limitaion of using local video
GeekSquirrel Mar 11, 2023
7d27d1e
update 'obsidian' version to fix npm vulnerability warnning
GeekSquirrel Mar 11, 2023
e2acc33
fully supported local file with file:// scheme
GeekSquirrel Mar 22, 2023
e9e1e7c
fix endless loop
GeekSquirrel Mar 22, 2023
e790103
fully support local video
GeekSquirrel Mar 22, 2023
f29fe2a
keep main.js, clone the repo and just use
GeekSquirrel Mar 22, 2023
58cced8
remove main.js in .gitignore
GeekSquirrel Mar 22, 2023
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
4 changes: 0 additions & 4 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@
# npm
node_modules

# Don't include the compiled main.js file in the repo.
# They should be uploaded to GitHub releases instead.
main.js

# Exclude sourcemaps
*.map

Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ This plugin solves this issue by allowing you to:

## Setup
- Download and enable the plugin
- Basic Usage
- Online Video: copy [valid link](##Valid-Video-Players) to editor, select it, search "Open Oneline Video" in command panel, or with your hotkey.
- Local Video: open a markdown file, search "Open Local Video" in command pannel, or with your hotkey. (See limitation for local video at [Known Issues](##Known-Issues))
- Set the hotkeys for
- Opening the video player (my default is cmnd-shift-y)
- Opening a local video (my defauly is cmnd-shift-l)
Expand Down Expand Up @@ -51,8 +54,6 @@ https://user-images.githubusercontent.com/39292521/167230491-f5439a62-a3f7-445c-
1. Inserting timestamps into a bulleted section does not work. Unfortunately, code-blocks cannot be in-line with text. Make sure to press enter/insert the timestamp on a new line.
2. If you decide to change the colors of your buttons/text, any old buttons/text will not update with the new colors until you reload the app. You can also click the '<>' when hovering over the code-block and it will refresh with the new colors.
3. If your timestamp/video button dont work, simply switch between live-editing and viewing modes.
4. Local videos currently cannot generate buttons. It's probably doable, but I couldn't find a way to make it work without glitching.


## Other Authors
This plugin uses the react-player npm package: https://www.npmjs.com/package/react-player.
Loading