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 more demo gifs for readme.md #52

Merged
merged 3 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@

Useful when transferring code to GPT, embedding in blogs, or for documentation purposes!

![Demo GIF](images/demo.gif)
![Demo GIF](images/demo/demo.gif)

## Features

- Automatically adds the file name at the top of any copied code, so that the file name is displayed when pasted.
- Option to include file path, or just the file name.
- Automatically detects the language of the file being copied and inserts the file path in an appropriate comment format.
- Optionally wrap codeblock with backticks(```).
![Demo GIf for language option](images/demo/demo_language.gif)
- Optionally wrap codeblock with backticks(```) when `YOCO.useBacktick` is set true.
![gif for backtick option](images/demo/demo_backtick.gif)

### Key Binding

Expand Down
Binary file removed images/demo.gif
Binary file not shown.
Binary file added images/demo/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/demo/demo_backtick.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/demo/demo_language.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.