Add instructions how to install using vim-plug

[sstark]

Is your feature request related to a problem? Please describe.
I tried to install peek using vim-plug using the following:

Plug 'toppair/peek.nvim'
lua <<EOF
require("peek").setup()
EOF

but that does not seem to make it work. If then try:

:lua require("peek").open{}

I get:

Peek error: error: Module not found "file:///home/seb/.config/nvim/plugged/peek.nvim/public/main.bundle.js".

Describe the solution you'd like
A clear and concise description of how to install peek using vim-plug. Likely there is a build step missing, but where and how to add it is unclear.

Thanks!

[egoarka]

Navigate to peek.nvim folder, in my case it's located by this path ~/.local/share/nvim/plugged/peek.nvim and run this command: deno task --quiet build:fast. It might be that you didn't have deno installed beforehand. Make sure it's installed.

[sstark]

Thank you @egoarka , with this information I could proceed. I didn't know it needs to be run in this directory.

[pmatulis]

i'm also using vim-plug and it doesn't work for me

vim-plug shows peek as being installed

i installed deno via homebrew

i went to the plugin's directory (~/.local/share/nvim/plugins/peek.nvim) and ran the suggested command, even though deno was installed prior to installing the plugin:

deno task --quiet build:fast
Download https://deno.land/std@0.217.0/cli/parse_args.ts
Download https://deno.land/std@0.217.0/path/mod.ts
Download https://deno.land/x/open@v0.0.6/index.ts
Download https://deno.land/x/webview@0.7.6/mod.ts
Download https://deno.land/std@0.217.0/cli/parse_args.ts
Download https://deno.land/std@0.217.0/collections/sliding_windows.ts
Download https://esm.sh/morphdom@2.7.2?no-dts
Download https://deno.land/std@0.217.0/assert/assert.ts
Download https://deno.land/std@0.217.0/path/windows/mod.ts
Download https://deno.land/std@0.217.0/path/posix/mod.ts
Download https://deno.land/std@0.217.0/path/basename.ts
Download https://deno.land/std@0.217.0/path/constants.ts
Download https://deno.land/std@0.217.0/path/dirname.ts
Download https://deno.land/std@0.217.0/path/extname.ts
Download https://deno.land/std@0.217.0/path/format.ts
Download https://deno.land/std@0.217.0/path/from_file_url.ts
Download https://deno.land/std@0.217.0/path/is_absolute.ts
Download https://deno.land/std@0.217.0/path/join.ts
Download https://deno.land/std@0.217.0/path/normalize.ts
Download https://deno.land/std@0.217.0/path/parse.ts
Download https://deno.land/std@0.217.0/path/relative.ts
Download https://deno.land/std@0.217.0/path/resolve.ts
Download https://deno.land/std@0.217.0/path/to_file_url.ts
Download https://deno.land/std@0.217.0/path/to_namespaced_path.ts
Download https://deno.land/std@0.217.0/path/common.ts
Download https://deno.land/std@0.217.0/path/_interface.ts
Download https://deno.land/std@0.217.0/path/glob_to_regexp.ts
Download https://deno.land/std@0.217.0/path/is_glob.ts
Download https://deno.land/std@0.217.0/path/join_globs.ts
Download https://deno.land/std@0.217.0/path/normalize_glob.ts
Download https://deno.land/std@0.106.0/path/posix.ts
Download https://deno.land/x/is_wsl@v1.1.0/mod.ts
Download https://deno.land/std@0.217.0/log/mod.ts
Download https://cdn.skypack.dev/highlight.js@11.9.0
Download https://esm.sh/markdown-it@14.0.0
Download https://esm.sh/markdown-it-emoji@3.0.0
Download https://esm.sh/markdown-it-footnote@4.0.0
Download https://esm.sh/markdown-it-task-lists@2.1.1
Download https://esm.sh/markdown-it-texmath@1.0.0
Download https://esm.sh/katex@0.16.9
Download https://deno.land/x/webview@0.7.6/src/webview.ts
Download https://deno.land/x/webview@0.7.6/src/ffi.ts
Download https://deno.land/std@0.217.0/assert/assert.ts
Download https://deno.land/std@0.217.0/assert/assertion_error.ts
Download https://deno.land/std@0.217.0/path/windows/basename.ts
Download https://deno.land/std@0.217.0/path/windows/constants.ts
Download https://deno.land/std@0.217.0/path/windows/dirname.ts
Download https://deno.land/std@0.217.0/path/windows/extname.ts
Download https://deno.land/std@0.217.0/path/windows/format.ts
Download https://deno.land/std@0.217.0/path/windows/from_file_url.ts
Download https://deno.land/std@0.217.0/path/windows/is_absolute.ts
Download https://deno.land/std@0.217.0/path/windows/join.ts
Download https://deno.land/std@0.217.0/path/windows/normalize.ts
Download https://deno.land/std@0.217.0/path/windows/parse.ts
Download https://deno.land/std@0.217.0/path/windows/relative.ts
Download https://deno.land/std@0.217.0/path/windows/resolve.ts
Download https://deno.land/std@0.217.0/path/windows/to_file_url.ts
Download https://deno.land/std@0.217.0/path/windows/to_namespaced_path.ts
Download https://deno.land/std@0.217.0/path/windows/common.ts
Download https://deno.land/std@0.217.0/path/windows/glob_to_regexp.ts
Download https://deno.land/std@0.217.0/path/windows/is_glob.ts
Download https://deno.land/std@0.217.0/path/windows/join_globs.ts
Download https://deno.land/std@0.217.0/path/windows/normalize_glob.ts
Download https://deno.land/std@0.217.0/path/posix/basename.ts
Download https://deno.land/std@0.217.0/path/posix/constants.ts
Download https://deno.land/std@0.217.0/path/posix/dirname.ts
Download https://deno.land/std@0.217.0/path/posix/extname.ts
Download https://deno.land/std@0.217.0/path/posix/format.ts
Download https://deno.land/std@0.217.0/path/posix/from_file_url.ts
Download https://deno.land/std@0.217.0/path/posix/is_absolute.ts
Download https://deno.land/std@0.217.0/path/posix/join.ts
Download https://deno.land/std@0.217.0/path/posix/normalize.ts
Download https://deno.land/std@0.217.0/path/posix/parse.ts
Download https://deno.land/std@0.217.0/path/posix/relative.ts
Download https://deno.land/std@0.217.0/path/posix/resolve.ts
Download https://deno.land/std@0.217.0/path/posix/to_file_url.ts
Download https://deno.land/std@0.217.0/path/posix/to_namespaced_path.ts
Download https://deno.land/std@0.217.0/path/posix/common.ts
Download https://deno.land/std@0.217.0/path/posix/glob_to_regexp.ts
Download https://deno.land/std@0.217.0/path/posix/is_glob.ts
Download https://deno.land/std@0.217.0/path/posix/join_globs.ts
Download https://deno.land/std@0.217.0/path/posix/normalize_glob.ts
Download https://deno.land/std@0.217.0/path/_os.ts
Download https://deno.land/x/webview@0.7.6/deps.ts
Download https://deno.land/std@0.217.0/assert/assertion_error.ts
Download https://deno.land/std@0.217.0/path/_common/common.ts
Download https://deno.land/std@0.106.0/path/_constants.ts
Download https://deno.land/std@0.106.0/path/_util.ts
Download https://deno.land/x/is_docker/mod.ts
Download https://deno.land/std@0.217.0/log/base_handler.ts
Download https://deno.land/std@0.217.0/log/console_handler.ts
Download https://deno.land/std@0.217.0/log/file_handler.ts
Download https://deno.land/std@0.217.0/log/rotating_file_handler.ts
Download https://deno.land/std@0.217.0/log/levels.ts
Download https://deno.land/std@0.217.0/log/logger.ts
Download https://deno.land/std@0.217.0/log/formatters.ts
Download https://deno.land/std@0.217.0/log/critical.ts
Download https://deno.land/std@0.217.0/log/debug.ts
Download https://deno.land/std@0.217.0/log/error.ts
Download https://deno.land/std@0.217.0/log/get_logger.ts
Download https://deno.land/std@0.217.0/log/info.ts
Download https://deno.land/std@0.217.0/log/setup.ts
Download https://deno.land/std@0.217.0/log/warn.ts
Download https://deno.land/x/plug@1.0.2/mod.ts
Download https://deno.land/x/plug@1.0.2/download.ts
Download https://deno.land/x/plug@1.0.2/deps.ts
Download https://deno.land/x/plug@1.0.2/types.ts
Download https://deno.land/x/plug@1.0.2/util.ts
Download https://deno.land/std@0.184.0/path/mod.ts
Download https://deno.land/std@0.184.0/fs/mod.ts
Download https://deno.land/std@0.184.0/encoding/hex.ts
Download https://deno.land/std@0.184.0/fmt/colors.ts
Download https://cdn.skypack.dev/-/highlight.js@v11.9.0-bSUFWqJEEn57ytKpUEAb/dist=es2019,mode=imports/optimized/highlightjs.js
Download https://deno.land/std@0.184.0/_util/os.ts
Download https://deno.land/std@0.184.0/path/win32.ts
Download https://deno.land/std@0.184.0/path/posix.ts
Download https://deno.land/std@0.184.0/path/common.ts
Download https://deno.land/std@0.184.0/path/separator.ts
Download https://deno.land/std@0.184.0/path/_interface.ts
Download https://deno.land/std@0.184.0/path/glob.ts
Download https://deno.land/std@0.184.0/fs/empty_dir.ts
Download https://deno.land/std@0.184.0/fs/ensure_dir.ts
Download https://deno.land/std@0.184.0/fs/ensure_file.ts
Download https://deno.land/std@0.184.0/fs/ensure_link.ts
Download https://deno.land/std@0.184.0/fs/ensure_symlink.ts
Download https://deno.land/std@0.184.0/fs/exists.ts
Download https://deno.land/std@0.184.0/fs/expand_glob.ts
Download https://deno.land/std@0.184.0/fs/move.ts
Download https://deno.land/std@0.184.0/fs/copy.ts
Download https://deno.land/std@0.184.0/fs/walk.ts
Download https://deno.land/std@0.184.0/fs/eol.ts
Download https://esm.sh/entities@^4.4.0?target=denonext
Download https://esm.sh/linkify-it@^5.0.0?target=denonext
Download https://esm.sh/mdurl@^2.0.0?target=denonext
Download https://esm.sh/punycode.js@^2.3.1?target=denonext
Download https://esm.sh/uc.micro@^2.0.0?target=denonext
Download https://esm.sh/markdown-it@14.0.0/denonext/markdown-it.mjs
Download https://esm.sh/morphdom@2.7.2/denonext/morphdom.mjs
Download https://cdn.skypack.dev/@types/mermaid?dts
Download https://esm.sh/markdown-it-emoji@3.0.0/denonext/markdown-it-emoji.mjs
Download https://esm.sh/markdown-it-footnote@4.0.0/denonext/markdown-it-footnote.mjs
Download https://esm.sh/markdown-it-task-lists@2.1.1/denonext/markdown-it-task-lists.mjs
Download https://esm.sh/katex?target=denonext
Download https://esm.sh/markdown-it-texmath@1.0.0/denonext/markdown-it-texmath.mjs
Download https://esm.sh/katex@0.16.9/denonext/katex.mjs
Download https://deno.land/std@0.217.0/path/_common/basename.ts
Download https://deno.land/std@0.217.0/path/_common/constants.ts
Download https://deno.land/std@0.217.0/path/_common/strip_trailing_separators.ts
Download https://deno.land/std@0.217.0/path/windows/_util.ts
Download https://deno.land/std@0.217.0/path/_common/dirname.ts
Download https://deno.land/std@0.217.0/path/_common/assert_path.ts
Download https://deno.land/std@0.217.0/path/_common/format.ts
Download https://deno.land/std@0.217.0/path/_common/from_file_url.ts
Download https://deno.land/std@0.217.0/path/_common/normalize.ts
Download https://deno.land/std@0.217.0/path/_common/normalize_string.ts
Download https://deno.land/std@0.217.0/path/_common/relative.ts
Download https://deno.land/std@0.217.0/path/_common/to_file_url.ts
Download https://deno.land/std@0.217.0/path/_common/glob_to_reg_exp.ts
Download https://deno.land/std@0.217.0/path/posix/_util.ts
Download https://deno.land/std@0.217.0/fmt/colors.ts
Download https://deno.land/std@0.217.0/fs/exists.ts
Download https://deno.land/std@0.217.0/log/_state.ts
Download https://deno.land/std@0.217.0/log/_config.ts
Download https://deno.land/std@0.184.0/path/_constants.ts
Download https://deno.land/std@0.184.0/path/_util.ts
Download https://deno.land/std@0.184.0/_util/asserts.ts
Download https://deno.land/std@0.184.0/fs/_util.ts
Download https://cdn.skypack.dev/-/@types/mermaid@v9.2.0-pzeUsl8991wW0ORkKqNC/dist=es2019,mode=imports/optimized/@types/mermaid.js
Download https://cdn.skypack.dev/-/highlight.js@v11.9.0-bSUFWqJEEn57ytKpUEAb/dist=es2019,mode=imports/optimized/common/core-62ddff3d.js
Download https://cdn.skypack.dev/-/highlight.js@v11.9.0-bSUFWqJEEn57ytKpUEAb/dist=es2019,mode=imports/optimized/common/wasm-cf9dcc58.js
Download https://esm.sh/entities@4.5.0/denonext/lib/decode.mjs
Download https://esm.sh/entities@4.5.0/denonext/lib/escape.mjs
Download https://esm.sh/entities@4.5.0/denonext/entities.mjs
Download https://esm.sh/linkify-it@5.0.0/denonext/linkify-it.mjs
Download https://esm.sh/mdurl@2.0.0/denonext/mdurl.mjs
Download https://esm.sh/punycode.js@2.3.1/denonext/punycode.mjs
Download https://esm.sh/uc.micro@2.1.0/denonext/uc.micro.mjs
Download https://esm.sh/katex@0.16.21/denonext/katex.mjs

there is no PeekOpen or PeekClose command available

[pmatulis]

i tried to open it manually and it worked:

lua require("peek").open{}

what do i need to do to get the neovim commands?

[pmatulis]

i got it to work. for any future travelers:

i am calling the plugin from my hybrid Lua/VimL configuration like this:

lua << EOF
.
.
.
require("peek-conf")
EOF

and peek-conf.lua looks like this:

require("peek").setup({
  auto_load = true,         -- whether to automatically load preview when
                            -- entering another markdown buffer
  close_on_bdelete = true,  -- close preview window on buffer delete

  syntax = true,            -- enable syntax highlighting, affects performance

  theme = 'dark',           -- 'dark' or 'light'

  update_on_change = true,

  app = 'webview',          -- 'webview', 'browser', string or a table of strings
                            -- explained below

  filetype = { 'markdown' },-- list of filetypes to recognize as markdown

  -- relevant if update_on_change is true
  throttle_at = 200000,     -- start throttling when file exceeds this
                            -- amount of bytes in size
  throttle_time = 'auto',   -- minimum amount of time in milliseconds
                            -- that has to pass before starting new render
})

vim.api.nvim_create_user_command("PeekOpen", require("peek").open, {})
vim.api.nvim_create_user_command("PeekClose", require("peek").close, {})