Skip to content

Update documentation for known limitations #162

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
manish-makwana wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −11
Open

Update documentation for known limitations #162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ best components of vimium and adapting them to Safari.
7. Go back to Vimari.app and press the reload button to check the status of the app. If it says "Enabled" then it is ready.
8. You may need to relaunch Safari for the extension to work



### Safari 11 (legacy Safari Extension method)

[Download the Vimari 1.13](https://github.com/guyht/vimari/releases/tag/v1.13) and double-click
Expand Down Expand Up @@ -100,6 +98,17 @@ for HTML elements having cursor style set to "pointer".
x Close current tab
t Open new tab

## Known Limitations

There are some limitations in the Safari extensions API, which in turn
limit Vimari.

1. On an "Empty Page", a "Top Sites" page, a "Favourites" page,
or a page which doesn't load like localhost, Vimari is not injected,
and cannot provide any keyboard shortcuts. To work around this, use
the regular Safari shortcuts for navigating away from a new window
or new tab.

## License

Copyright (C) 2011 Guy Halford-Thompson. See [LICENSE](LICENSE) for details.
18 changes: 9 additions & 9 deletions docs/safari_12.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# Installation notes for Safari version 12 and 13

A new version of macOS is being released, macOS Mojave, and it's expected to
have a stable release out September or October of 2018. With that new version
comes Safari 12, and a [completely new way of dealing with browser
extensions](https://developer.apple.com/documentation/safariservices/safari_app_extensions).
In September 2018 macOS Mojave was released. This came with Safari 12, and a
[completely new way of dealing with browser extensions]
(https://developer.apple.com/documentation/safariservices/safari_app_extensions).
[We have had some issues](./crowdfunding.md) related to releasing new version
of this extension, but they are now fixed and it's possible to install a version
of vimari for Safari 12.
of vimari for Safari 12+.

## How to install
## How to install for development
**Note: We are currently working on improving this installation flow, as well
as the extension itself. Because vimari now has to be released as a _Safari
App Extension_ instead of a _Safari Extension_ it requires some fundamental
changes to the code. We can't guarantee that all the features work in
this version. It's a learning process for us so bare with us.**
this version. It's a learning process for us so bear with us.**

1. Clone this repo
```sh
Expand All @@ -32,5 +31,6 @@ this version. It's a learning process for us so bare with us.**
7. You may now press stop in Xcode and close Xcode. The extension will be
available even if you restart Safari.

This was tested on High Sierra with Safari Technology Preview (version 12). Let
us know if something is not working for you.
This was tested on High Sierra with Safari Technology Preview (version 12) and
on Catalina with Safari 13.0.3 (Xcode 11.2.1). Let us know if something is not
working for you.