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

export/import of settings is not fully documented #2175

Open
aspiers opened this issue Oct 9, 2024 · 0 comments
Open

export/import of settings is not fully documented #2175

aspiers opened this issue Oct 9, 2024 · 0 comments

Comments

@aspiers
Copy link
Contributor

aspiers commented Oct 9, 2024

Prelude

Details

It seems there are multiple ways to import settings, e.g.:

  • In Advanced mode, paste settings Javascript code into the editor.
  • Save Javascript settings in a file, and in Advanced mode, configure the extension to load the settings from this file.
  • Type ;pj to restore settings (in JSON format?) from the clipboard.

and multiple ways to export settings, e.g.:

  • Type yj to save settings in the clipboard in JSON format.
  • Copy Javascript from the settings editor into the clipboard.

I found it difficult to figure out whether some of these used JSON format or Javascript format. In particular the format used by yj and ;pj doesn't seem to be documented anywhere other than one cryptic mention in the README:

`Alt-s` once more will remove it from settings.blocklist. The data settings are not always presented in snippets, you could use `yj` to dump all settings into clipboard, then paste it in your text editor to check out.

Eventually I figured out that typing yj and then pasting the resulting clipboard contents into jq -r .snippets would convert it into Javascript form which can be used in the editor or saved in a local file which the extension loads from. But this is far from obvious. So it would be good to improve the docs to explain all this more explicitly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant