Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kotfu/marked-bonus-pack

Scripts, commands, and services that make the Marked app for macOS more useful
https://github.com/kotfu/marked-bonus-pack

Last synced: about 2 months ago
JSON representation

Scripts, commands, and services that make the Marked app for macOS more useful

Awesome Lists containing this project

README 

        
# Marked Bonus Pack



The Marked Bonus Pack is a collection of scripts, commands, services, and

documentation. Some work with multiple editors, some are specific to certain

editors. The Services will generally work with any editor that has the necessary

capabilities. The rest are organized in folders based on the application they

work with.



These items work with [Marked 2](http://marked2app.com). If you need support for

the original version of Marked, you will need to download [Marked Bonus Pack

1.5](https://github.com/kotfu/marked-bonus-pack/releases/tag/v1.5)



## Works With Marked



Some applications work with Marked out of the box and don't require you to

install anything else. These applications take advantage of the Marked

[Streaming Preview](https://marked2app.com/help/Streaming_Preview.html) feature.

This feature requires developers to implement Marked support in their

application. Some apps will have a Preview command to manually send updates to

Marked, others will automatically update without any interaction from the user.



### Drafts



[Drafts for Mac](https://getdrafts.com/) includes support for Streaming Preview,

but you must enable it:



- Open Drafts

- Click on the **Drafts > Preferences** menu (or press ⌘,)

- Click on the `General` tab

- Select the `Enable Marked App Streaming Preview support` checkbox.

- Click the `Open Marked` button to launch Marked and open the `Streaming Preview` window

- Close the Drafts Preferences window



Now you have a live Marked preview that updates as you type in Drafts.



Tip: You can re-open the `Streaming Preview` window in Marked by clicking the

**Preview > Streaming Preview** menu.



### nvALT



Enable the Streaming Preview in [nvALT](https://brettterpstra.com/projects/nvalt/)

by selecting the **Preview > Streaming Preview in Marked** menu option.



### The Archive



[The Archive](https://zettelkasten.de/the-archive/) includes support for

Streaming Preview. Choose the **Note > Stream Preview to Marked** menu option to

enable. The Marked preview updates as you type, no saving required.



## Installation and Usage



If you aren't familiar with GitHub, click on the green button that says `Code`

at the top of this page and then choose `Download Zip`. Unzip the file on your

computer.



If you are familiar with GitHub, you know what to do.



For some of the installation targets listed below — specifically

__Services__, __BBEdit__, __Sublime Text__, and __iA Writer__ — you can use

the provided

[install](./install) script.



### Services



Put the Services in `~/Library/Services`, where `~` is your user's home folder.

If you want hotkeys for the services, assign them in **System

Preferences > Keyboard > Shortcuts > Services**.



### BBEdit



Place `BBEdit/Open in Marked.applescript` in `~/Library/Application Support/BBEdit/Scripts/`.

Use from the Script menu bar item while editing a Markdown document (must be

saved first). You can assign a keyboard shortcut in BBEedit **Preferences > Menus

& Shortcuts**.



### TextMate



Double-click on the `Marked 2` bundle to open it in TextMate's Bundle Editor.

You can access the preview commands using the ⌃⌥M keyboard

shortcut. There are two of these commands, one previews the current document and

will watch the associated file for future changes, the other previews the

current selection using a temporary file. The latter will not update

automatically.



### Sublime Text



Copy the `Marked 2.sublime-build` file to `~/Library/Application Support/Sublime

Text 3/Packages/User/`. It will show up in the **Build Systems** section of the

**Tools** menu in Sublime. When selected, pressing ⌘B will open the current file

in Marked for preview. Once opened, changes to the file will be tracked

automatically by Marked.



(This extension will also work with Sublime Text 2. Just copy

`Marked 2.sublime-build` to

`~/Library/Application Support/Sublime Text 2/Packages/User/`.)



### Vim



Via [A Whole Lot of Bollocks](http://captainbollocks.tumblr.com/post/9858989188/linking-macvim-and-marked-app).

Add the following to your .vimrc file:



	:nnoremap m :silent !open -a Marked\ 2.app '%:p'



**\m** (or your preferred leader) will now open the current file in Marked.



From [dixius99](https://github.com/dixius99):



You may prefer `:Marked` instead of using the leader key to launch Marked. To do that,

add the following to your .vimrc:



	command Marked :silent !open -a Marked\ 2.app '%:p'



The word right after "command" is what triggers the action. It can be anything

you want, but has to start with a capital letter.



### iA Writer



Via [stephenhowells](https://gist.github.com/stephenhowells/4599997):



Copy `iAWriter/Open in Marked.applescript` to `~/Library/Scripts/Applications/iA

Writer/`. Run by clicking the **Script > iA Writer > Open in Marked** menu.



### Emacs



Via [Barry](http://spacebeast.com/blog/)



Install the `dot.emacs.txt` file in one of the following ways (depending on how

you have configured your emacs startup):



 1. Append the contents of `dot.emacs.txt` to `~/.emacs`

 2. Append the contents of `dot.emacs.txt` to `~/.emacs.d/init.el`

 3. Copy `dot.emacs.txt` to `~/.emacs.d/marked2.el` and ensure it is loaded by `~/.emacs.d/init.el`

 

See

[The Emacs Initialization File](http://www.gnu.org/software/emacs/manual/html_node/emacs/Init-File.html)

for more information about emacs startup.



Once installed, restart Emacs. Press **Control-C m** to preview the file

associated with the current buffer in Marked 2.



### Visual Studio Code



This project does not contain anything to help you integrate with [Visual Studio

Code](https://code.visualstudio.com/). However, Fabian Morón Zirfas has created

an [Open in Marked

Extension](https://marketplace.visualstudio.com/items?itemName=fmoronzirfas.open-in-marked).

Once the extension is installed, you can open the current file in Marked 2 by

typing ⇧⌘P and then typing `marked` to narrow the list of commands, and then

selecting "Open In Marked 2".



To bind it to a keyboard shortcut, select the **Code > Preferences > Keyboard Shortcuts**

menu to open the keyboard shortcuts editor. Type `marked` to narrow the list

of commands, and then double-click on "Open in Marked 2". Type the keyboard shortcut

you want, and press **Return**.



See [Key Bindings for Visual Studio Code](https://code.visualstudio.com/docs/getstarted/keybindings)

for more information on binding shortcuts to commands.



### AppleScript



There's one AppleScript included that performs essentially the same function as

the Open in Marked Service, but with some special accommodations for [Notational

Velocity](http://notational.net/) and

[nvALT](http://brettterpstra.com/project/nvalt/). In order to use it, two

configuration variables need to be edited at the top of the script. Open the

.applescript file in AppleScript Editor and modify the `property` lines at the

top, then save it as a compiled script (scpt) file. You can then run it from the

AppleScript menu (enabled in the AppleScript Editor preferences), or from a

hotkey-capable application like

[FastScripts](http://www.red-sweater.com/fastscripts/).



### Watchers



Marked version 1 required some watcher scripts to work with Scrivener and

MarsEdit. Marked 2 has built in support for these applications, and no watcher

scripts are required.



More info: 



### Notes:



The easiest way to use these scripts is to put them in a convenient folder (I

use `~/scripts`) and run `chmod a+x path/to/script.rb` to make them executable.

You can then just type the path and script name and hit Enter (e.g.

`~/scripts/everwatch.rb`). They will run and watch for changes in their specific

application until you cancel the command by typing `Control-c`.



The scripts will create a file in your home directory (modifiable in the script)

called 'Marked Preview.md'. Open that file in Marked; Marked will watch that

file for changes that the scripts make.



You can create LaunchAgents for any of these and run them automatically in the

background if you know what you're doing. If you don't, you can still use an app

like [Lingon](http://www.peterborgapps.com/lingon/) to do it.



#### Evernote



To keep the 'Marked Preview.md' file synced with whatever note you're currently

editing in Evernote, start the script by running `~/path/to/everwatch.rb` in

Terminal. The script watches for changes to timestamps on any directory in

Evernote's data folder. This shouldn't need to be adjusted. To update Marked,

you'll need to have "~/Marked Preview.md" open and then hit "Command-S" in your

Evernote note. The autosave on Evernote will work, but it takes longer. 



The HTML of the note is captured via AppleScript and run through `textutil` to

remove the HTML formatting. This means that embedded images won't come through,

but those probably would have broken anyway. The script is specifically

expecting you to write your notes in Markdown. If you're not, I'm not sure why

you'd want a Marked preview anyway. Inline HTML works, but you have to watch

your quote marks very carefully. Evernote likes to convert the single and double

quote marks you type into "smart quotes", which Marked doesn't interpret as

HTML.



This watcher will not reliably if you have multiple Evernote user id's.



Even with "Command-S" there's still a 4-5 second delay on the update, as it

takes a bit for Evernote to write out to the file, the script to poll through

and notice the change, the content to be pulled via AppleScript and written to

the preview file and then for Marked to pick up on the change there. Considering

all of that, 4-5 seconds isn't too bad. If someone can think of a faster way,

I'm certainly open to it.



#### Notational Velocity/nvALT



If you store your notes as plain text files in NV/nvALT, you can just open the

notes folder in Marked 2 and it will always display a preview of the

most-recently edited file.



Watcher script:



If you're using [Notational Velocity][nv] (or my fork, [nvALT][nvalt]), you can

tell it to save your notes as text files on your drive. This script will watch

these text files for updates, then display the contents of the most

recently-edited note. It's a workable solution, at least until I get better

integration worked into nvALT directly.



You need to configure the script to point to your chosen folder for note

storage, and if you're using any unique extension, you'll need to add to or

modify the list in the script. It should be pretty obvious what needs to be set

if you look at the top of the script.



[nv]: http://notational.net

[nvalt]: http://brettterpstra.com/projects/nvalt



## Running multiple Custom Pre/Processors



If you use Marked's Custom Processor and/or Preprocessor functionality, you may want 

to check out [Conductor](https://github.com/ttscoff/marked-conductor "ttscoff/marked-conductor"), 

which allows you to run different processors based on natural language conditions. For example, 

run one custom (pre)processor for Obsidian notes, a different one for blog posts, and 

another one for GitHub READMEs. There's a sample config available at 

[github.com/ttscoff/conductor-config/](https://github.com/ttscoff/conductor-config/).