Skip to content

Simple program to view files in your browser. Text files, markdown, html, images, videos, audios, and fonts all work.

License

Notifications You must be signed in to change notification settings

kitesi/local-files-viewer

Repository files navigation

Local Files Viewer

Simple program to view files in your browser including text files, markdown, HTML, PDFs, images, videos, audio, and fonts.

Check out filebrowser, which might better suit your needs.

Previews

Markdown:

markdown

For more previews, visit previews.md

Security Note

I don't believe this program exposes any additional security threat, but in the instances of one, I am not responsible for any damages.

It uses the web browser's provided API for images, videos, audios, fonts, and iframes to display HTML & PDF content. It uses node's fs.readFile to read the file contents.

Installation

npm i -g local-files-viewer

Or install yourself:

git clone https://github.com/kitesi/local-files-viewer.git
cd local-files-viewer
npm install
npm run build
npm install -g

Usage

Once you have this package installed you can just call lfv [folder]. If no folder is provided, it will default to your env variable of LFV_DEFAULT_FOLDER.

Keybindings

h => go to previous file

l => go to next file

ctrl+p => toggle file finder

ctrl+o => toggle directory (allows you to change the base directory)

palette mode:

(file mode) ctrl+j, tab => next item

(file mode) ctrl+k, shift+tab => previous item

(directory mode) tab=> completion

(directory mode) shift+tab => nothing

ctrl+m, enter => select item

ctrl+[, Escape => close palette

Live View & Neovim Integration

This program automatically reloads the content when the current file is changed. If you would like to sync up the cursor position of neovim to the program then you can use the following configuration:

local uv = vim.loop

function OpenLfv()
	local current_dir = vim.fn.getcwd()
	local buffer_file = vim.fn.expand("%:p")
	local buffer_dir = vim.fn.fnamemodify(buffer_file, ":h")
	local target_dir = vim.fn.isdirectory(current_dir) == 1 and current_dir or buffer_dir

	if vim.fn.isdirectory(target_dir) == 1 then
		vim.cmd("tabnew | terminal lfv " .. vim.fn.shellescape(target_dir))

		local relative_path = vim.fn.fnamemodify(buffer_file, ":~:.")
		if relative_path:sub(1, #target_dir) == target_dir then
			relative_path = relative_path:sub(#target_dir + 2)
		end

		-- Launch browser after delay
		vim.fn.jobstart("sleep 2", {
			on_exit = function()
				local url = "http://localhost:4173/preview/" .. relative_path
				vim.fn.jobstart({ "xdg-open", url }, { detach = true })
			end,
		})

		-- Create autocmd to track cursor movements
		local debounce_timer = nil
		local group = vim.api.nvim_create_augroup("LfvLineSync", { clear = true })

		vim.api.nvim_create_autocmd({ "CursorMoved", "CursorMovedI" }, {
			group = group,
			callback = function()
				if debounce_timer then
					debounce_timer:stop()
					debounce_timer:close()
				end

				debounce_timer = vim.loop.new_timer()
				debounce_timer:start(
					150,
					0,
					vim.schedule_wrap(function()
						local line = vim.fn.line(".")
						local payload = string.format('{"file": "%s", "line": %d}', relative_path, line)

						vim.fn.jobstart({
							"curl",
							"-X",
							"POST",
							"-H",
							"Content-Type: application/json",
							"-d",
							payload,
							"http://localhost:4173/api/cursor-watcher",
						}, { detach = true })
					end)
				)
			end,
		})
	else
		print("No valid directory found.")
	end
end
vim.cmd("command! Lfv lua OpenLfv()")

About

Simple program to view files in your browser. Text files, markdown, html, images, videos, audios, and fonts all work.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •