Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Notes about installation via homebrew-cask #2

Merged
merged 1 commit into from
Oct 14, 2022
Merged

Notes about installation via homebrew-cask #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@ This is a quick fork of Fletcher Penney's [MMD Quicklook project][mmdql]. It add

![MultiMarkdown Quicklook with Style][screenshot]

To install, [download the zip][dl], unarchive and place the `MultiMarkdown QuickLook.qlgenerator` file in `~/Library/QuickLook/`. To make sure the Quick Look generator list reloads with the new file, you can run `qlmanage -r` on the command line.
#### Installation

To install, either use [homebrew-cask][cask]

```shell
brew cask install ttscoff-mmd-quicklook
```

or manually [download the zip][dl], unarchive and place the `MultiMarkdown QuickLook.qlgenerator` file in `~/Library/QuickLook/`. To make sure the Quick Look generator list reloads with the new file, you can run `qlmanage -r` on the command line.

To use a custom style, name the CSS file `.mdqlstyle.css` and place it in your User's home directory. Note the leading period. Default padding for the body class will be included before your styles, so you can pretty much drop in any CSS you want from any source. Use one of the provided files, copy CSS from your blog, your favorite website or build your own.

Expand All @@ -30,6 +38,7 @@ A couple of default styles lifted from [Marked.app][marked].

[mmdql]: https://github.com/fletcher/MMD-QuickLook
[screenshot]: https://github.com/ttscoff/MMD-QuickLook/raw/master/MMDQLGithub-1.jpg
[cask]: http://caskroom.io/
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be homebrew-cask, not simply cask.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? The link works in Marked2 app and also on https://github.com/oschrenk/MMD-QuickLook/tree/homebrew-cask-readme

According to http://daringfireball.net/projects/markdown/syntax#link the id is the the second bracket pair

This is [an example] [id] reference-style link.

Then, anywhere in the document, you define your link label like this, on a line by itself:

[id]: http://example.com/  "Optional Title Here"

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, yes, you are correct. I was thinking cask would be the name to appear, but homebrew-cask is. My mistake.

[dl]: https://github.com/ttscoff/MMD-QuickLook/releases/latest
[swissshot]: https://github.com/ttscoff/MMD-QuickLook/raw/master/MMDQLSwiss.jpg
[upshot]: https://github.com/ttscoff/MMD-QuickLook/raw/master/MMDQLUpstanding.jpg
Expand Down