Skip to content

Commit

Permalink
Improve README (#4, #6)
Browse files Browse the repository at this point in the history
  • Loading branch information
tuxu committed Apr 7, 2022
1 parent 323950c commit eb570b4
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# ipynb-quicklook

**Note**: This plugin has now been integrated into a native macOS app,
[Jupyter Notebook Viewer](https://github.com/tuxu/nbviewer-app).
**Note**: This plugin has now been integrated into a native macOS app, [Jupyter
Notebook Viewer](https://github.com/tuxu/nbviewer-app). This is the recommended
way to install the QuickLook generator.

A stand-alone [Quick Look](https://en.wikipedia.org/wiki/Quick_Look) generator
for [Jupyter](https://jupyter.org/)/[IPython](https://ipython.org/) notebooks on
Expand All @@ -12,10 +13,20 @@ macOS. Contents are rendered on-the-fly using

- Download `ipynb-quicklook.qlgenerator`
([Releases](https://github.com/tuxu/ipynb-quicklook/releases))
- Move the generator into `/Library/QuickLook`. You may need to run `qlmanage
- The generator is unsigned and not notarized by Apple. You need to remove the
quarantine attribute like this on macOS Catalina and later
([#6](https://github.com/tuxu/ipynb-quicklook/issues/6)):
```sh
xattr -d com.apple.quarantine ipynb-quicklook.qlgenerator
```
- Move the generator into `/Library/QuickLook` [^1]. You may need to run `qlmanage
-r` to reset the Quick Look server and caches.
- Press <kbd>space</kbd> whenever you encounter a `.ipynb` file. Enjoy 👍

[^1]: Note that the generator must be installed globally. Installation to
`~/Library/QuickLook/` is not sufficient (see
[#4](https://github.com/tuxu/ipynb-quicklook/issues/4)).

## Similar projects

- [jupyter-notebook-quick-look](https://github.com/jendas1/jupyter-notebook-quick-look):
Expand All @@ -30,4 +41,4 @@ macOS. Contents are rendered on-the-fly using
This project is licensed under the MIT license. See [LICENSE.md](LICENSE.md) for
details.

© 2017 [Tino Wagner](http://www.tinowagner.com/)
© 2017 [Tino Wagner](http://www.tinowagner.com/)

0 comments on commit eb570b4

Please sign in to comment.