An open API service indexing awesome lists of open source software.

https://github.com/emako/quicklook

About Bring macOS “Quick Look” feature to Windows, BUT modified version
https://github.com/emako/quicklook

Last synced: 2 months ago
JSON representation

About Bring macOS “Quick Look” feature to Windows, BUT modified version

Awesome Lists containing this project

README

        

# QuickLook

[![license](https://img.shields.io/github/license/QL-Win/QuickLook.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![AppVeyor](https://img.shields.io/appveyor/ci/xupefei/QuickLook.svg)](https://ci.appveyor.com/project/xupefei/QuickLook)
[![Github All Releases](https://img.shields.io/github/downloads/QL-Win/QuickLook/total.svg)](https://github.com/QL-Win/QuickLook/releases)
[![GitHub release](https://img.shields.io/github/release/QL-Win/QuickLook.svg)](https://github.com/QL-Win/QuickLook/releases/latest)

## Background
One of the few features I missed from macOS is [Quick Look](https://en.wikipedia.org/wiki/Quick_Look). It allows users to peek into a file content in lightning speed by just pressing the Space key. Windows, on the other hand, does not have this handy feature ... until now!

I am aware that several alternatives are already available on the Internet (e.g. [WinQuickLook](https://github.com/shibayan/WinQuickLook) and [Seer](https://github.com/ccseer/Seer)). Despite these options, I still decided to craft another one by myself, because they are either not being actively developed, lack of variety, or ask for some :dollar:.

## Highlights

- Tons of supported file types (full list [here](https://github.com/QL-Win/QuickLook/wiki/Supported-File-Types))
- Fluent design
- Touchscreen friendly
- HiDPI support
- Preview from *Open* and *Save File* Dialog
- Preview from 3rd-party file managers (see a list [here](https://github.com/QL-Win/QuickLook/wiki/File-Managers))
- Easily extended by [plugins](https://github.com/QL-Win/QuickLook/wiki/Available-Plugins)
- Strict GPL license to keep it free forever

## Modification

Here is a modified version of QuickLook that continues to maintain and enhance some features.

External [plugins](https://github.com/QL-Win/QuickLook/wiki/Available-Plugins) are compatible with the original version.

### What's the difference from the original QuickLook?

#### Functional differences

1. New build-in plugins
1. BinaryViewer
2. ExecutableViewer
3. FontViewer
4. HashViewer
2. Upgrade build-in plugins
1. Support dark mode with MarkdownViewer
3. Upgrade main program
1. Support dark mode NotifyIcon Tray Menu

#### Source code differences

1. Use .NET SDK type project.
2. Include Common project instead of using submodule.
3. Upgrade the versions of dependencies.
4. Fix some vulnerabilities.

## External Plugins

Some external plugins from me.

[PlantUMLViewer](https://github.com/emako/QuickLook.Plugin.PlantUMLViewer)

[TorrentViewer](https://github.com/emako/QuickLook.Plugin.TorrentViewer)

[XMindThumbnailViewer](https://github.com/emako/QuickLook.Plugin.XMindThumbnailViewer)

[DrawIOViewer](https://github.com/emako/QuickLook.Plugin.DrawIOViewer)

[MarkmapViewer](https://github.com/emako/QuickLook.Plugin.MarkmapViewer)

[FigmaThumbnailViewer](https://github.com/emako/QuickLook.Plugin.FigmaThumbnailViewer)

## Usage

### Download/Installation

Get it from one of the following sources:

* Microsoft Store (Windows 10 users only, no preview in open/save-dialogs available) Store Link
* Installer or portable archive of the stable version from [GitHub Release](https://github.com/QL-Win/QuickLook/releases)
* Nightly builds from [AppVeyor](https://ci.appveyor.com/project/xupefei/quicklook/build/artifacts)

[What are the differences between `.msi`, `.zip`, Nightly and Store versions?](https://github.com/QL-Win/QuickLook/wiki/Differences-Between-Distributions)

**Note:** Don't forget to check out the [plugins](https://github.com/QL-Win/QuickLook/wiki/Available-Plugins) for previewing office-files, epubs, fonts and more!

### Typical usecase

1. Run `QuickLook.exe` (only necessary if autostart is disabled)
1. Select any file or folder (on the Desktop, in a File Explorer window, in an *Open* or *Save-File* dialogue, doesn't matter)
1. Press Spacebar
1. Enjoy the preview and interact with it
1. Preview next file by clicking on it or using arrow-keys (arrow-keys move selection in the background if the preview window is not in focus)
1. When you're done close it by either hitting Spacebar again, pressing Esc or clicking the `⨉` button

### Hotkeys and buttons

- Spacebar Show/Hide the preview window
- Esc Hide the preview window
- Enter Open/Execute current file
- Mouse Preview another file
- Mouse Wheel Zoom in/out (images)
- Ctrl+Mouse Wheel Zoom in/out (PDFs)
- Wheel Increase/decrease volume

## Supported file types, file manager integration, etc.

See the [Wiki page](https://github.com/QL-Win/QuickLook/wiki)

## Translations

See the [Translation guide](https://github.com/QL-Win/QuickLook/wiki/Translations)

## Thanks to

- Many [open-source projects](https://github.com/QL-Win/QuickLook/wiki/On-the-Shoulders-of-Giants) and their contributors
- Our UI designers [@OiCkilL](https://twitter.com/OiCkilL) (“Fluent” user interface since v0.3), [@QubitsDev](https://twitter.com/qubitsdev) (app-icon v0.3-v3.6.9) and [Donno](https://github.com/Donnnno) (app-icon since v3.6.10)
- [Our contributers](https://github.com/QL-Win/QuickLook/graphs/contributors) who
- teach QuickLook to speak *your* language
- send pull requests, report bugs or give suggestions
- ... and you 😊

## Licenses

![GPL-v3](https://www.gnu.org/graphics/gplv3-127x51.png)

This project references many other open-source projects. See [here](https://github.com/QL-Win/QuickLook/wiki/On-the-Shoulders-of-Giants) for the full list.

All source codes are licensed under [GPL-3.0](https://opensource.org/licenses/GPL-3.0).

If you want to make any modification on these source codes while keeping new codes not protected by GPL-3.0, please contact me for a sublicense instead.