Awesome

About

This is a fork of the original Glance plugin. Unfortunately, the owner seems to have discarded the project a while ago, and the app is largely broken on newer macOS systems. The aim of this fork is to revive the project and maintain it for future updates. For now, we have added support for macOS Big Sur and fixed several internal bugs.

Installation

The installation is slightly complex as the package is not notarized. The steps are as follows:

1. Download the .dmg file from releases, open the file and drag Glance.app to Applications.
2. Alternatively, install Glance through Homebrew using brew install glance-chamburr.
3. Open a terminal and run the following command.

   xattr -rd com.apple.quarantine /Applications/Glance.app
   

4. Launch Glance. Enjoy!

Supported file types

• Source code (with Chroma syntax highlighting): .cpp, .js, .json, .py, .swift, .yml and many more

  <p><img src="./AppStore/Assets/Screenshots/ScreenshotSourceCode.png" alt="" width="600"></p>

• Markdown (rendered using goldmark): .md, .markdown, .mdown, .mkdn, .mkd, .Rmd, .qmd

  <p><img src="./AppStore/Assets/Screenshots/ScreenshotMarkdown.png" alt="" width="600"></p>

• Archive: .tar, .tar.gz, .zip

  <p><img src="./AppStore/Assets/Screenshots/ScreenshotArchive.png" alt="" width="600"></p>

• Jupyter Notebook (rendered using nbtohtml): .ipynb

  <p><img src="./AppStore/Assets/Screenshots/ScreenshotJupyterNotebook.png" alt="" width="600"></p>

• Tab-separated values (parsed using SwiftCSV): .tab, .tsv

  <p><img src="./AppStore/Assets/Screenshots/ScreenshotTSV.png" alt="" width="600"></p>

FAQ

There are existing Quick Look apps for some of the supported file types. Why create another one?

• Glance combines the features of many plugins into one and provides consistent and beautiful previews.
• Glance is fully compatible with Dark Mode.
• Some plugins still use the deprecated Quick Look Generator API and might stop working in the future.
• Glance can easily be extended to support other file types.

Why isn't the app available on macOS 10.14 or older?

The app uses the new Quick Look API that was introduced in 10.15, so it unfortunately won't work with older versions of macOS.

Why are images in my Markdown files not loading?

Glance blocks remote assets. Furthermore, the app only has access to the file that's being previewed. Local image files referenced from Markdown are therefore not loaded.

Why isn't [file type] supported?

Feel free to open an issue or contribute! When opening an issue, please describe what kind of preview you'd expect for your file.

Please note that macOS doesn't allow the handling of some file types (e.g. .plist, .ts and .xml).

You claim to support [file type], but previews aren't showing up.

Please note that Glance skips previews for large files to avoid slowing down your Mac.

It's possible that your file's extension or UTI isn't associated with Glance. You can easily verify this:

1. Check whether the file extension is matched to the correct class in PreviewVCFactory.swift.
2. Find your file's UTI by running mdls -name kMDItemContentType /path/to/your/file. Check whether the UTI is listed under QLSupportedContentTypes in Info.plist.
3. If an association is missing, please feel free to add it and submit a PR.

Contributing

Suggestions and contributions are always welcome! Please discuss larger changes (e.g. adding support for a new file type) via issue before submitting a pull request.

Xcode, Swift and Go need to be installed to build the app locally.

To add previews for a new file extension, please follow these steps:

1. Create a new class for your file type in this directory. It should implement the Preview protocol. See the other files in the directory for examples.
2. Match the file extension to your class in PreviewVCFactory.swift.
3. Find your file's UTI by running mdls -name kMDItemContentType /path/to/your/file. Add it to QLSupportedContentTypes in Info.plist.
4. Update README.md, SupportedFilesWC.xib, the App Store description and Credits.rtf (if you introduced a new library).

License

This project is licensed under MIT License.