This article originally appeared in TidBITS on 2013-11-01 at 12:42 p.m.
The permanent URL for this article is:
Include images: Off

Marked 2: A Must-Have for Markdown Writers

by Josh Centers

Inspired in part by setext [1], the lightweight markup language designed for TidBITS in 1992, John Gruber’s Markdown [2] revolutionized the way people write for the Web a dozen years later. Writers were freed from coding cumbersome HTML tags or managing bloated Web design apps; Markdown provides a standard method of writing a plain text document that can easily be converted to HTML for display on a Web site.

Markdown is now used in many content management systems, including our own TidBITS Publishing System, where the connection with setext made adoption easy. Book publishing services like Leanpub [3] rely on Markdown too, and Take Control uses Markdown as part of our ebook workflow (see “Celebrating Ten Years of Take Control [4],” 28 October 2013). Markdown’s simplicity has even made writing more accessible, making it easier for the vision-impaired to become authors (see “With Markdown, Even the Blind Can Write [5],” 18 June 2013).

Besides Gruber, the man most responsible for the popularity of Markdown is programmer Brett Terpstra. He has released a plethora of excellent free tools [6] for users of the markup language, including:

But there’s one tool Brett Terpstra charges money for: Marked 2 [7], a Markdown previewer. It costs $11.99 directly from Terpstra’s Web site, with a free 7-day trial available. The original version of Marked is available in the Mac App Store for $3.99, but lacks some of the features of Marked 2. Terpstra told me that Marked 2 may return to the Mac App Store in the future.

At first blush, Marked 2 is incredibly simple. Drop a Markdown-formatted text file onto Marked’s app icon and a window pops up with a preview of how the file will look on the Web. You can even drag the proxy icon from a text editor’s title bar into Marked, and the preview updates every time you save. (I use Gabe Weatherhead’s Keyboard Maestro macro [8] to open BBEdit documents in Marked.) The Marked preview shows live links and even images, if you stick to standard Markdown format.

[image link] [9]

But Marked isn’t just a Markdown previewer — BBEdit users can choose Markup > Preview in BBEdit for that. Marked goes further, providing a powerful editing and formatting package that both expands upon Markdown’s capabilities and makes you a better writer. Let’s take a look at the top features.

Statistics -- You might have noticed in the above screenshot that Marked displays a word count at the bottom of the window. Click it (or press Command-Option-S) and it also shows the number of paragraphs, sentences, and characters. Select some text, and a little statistics balloon reports word, character, and line counts for the selection.

If you choose Preview > Detailed Statistics (Command-I — this menu item is also available by clicking the gear icon in the lower-right corner of Marked’s window), Marked displays a lovely set of in-depth stats, including average words per sentence, percentage of complex words, reading ease, grade level, fog index [10], and even an estimate of how long the document will take to read. From the Preview menu, you can also choose to show readability statistics at the bottom instead of paragraph, sentence, and character counts (or just Option-click the word count display).

[image link] [11]

Keywords and Word Repetition -- Even the best writers can get stuck on a certain word, using it over and over, or resort to clichés and junk words like “very.” There are plenty of tools to check spelling and grammar, but Marked is the only editing tool I’ve used that addresses these writing tics.

To see if you’re overusing a word, choose Preview > Visualize Word Repetition (Control-Command-W). Repeated words are highlighted in pink, and if you hover over one with your mouse pointer, Marked darkens the highlight and shows other instances of the same word.

[image link] [12]

To check for verboten words, choose Preview > Highlight Keywords (Command-Shift-H). Marked comes with a dictionary of words and phrases to avoid or replace, such as: “actually,” “very,” and “really.” It highlights these with four colors: pink for words to avoid, purple for those for which you might want to find alternatives, blue for other words you’ve told Marked to highlight, and green for custom — which denotes temporary keywords.

[image link] [13]

Temporary keywords are just that — words you want to highlight for a single document. To set them, choose Preview > Keyword Drawer (Command-Shift-K) or click the arrow icon at the bottom of the window. A pop-up appears with a notepad for temporary keywords. Enter one per line, and click Update to highlight those words in green.

[image link] [14]

It would be nice to be able to create temporary keywords to avoid checking as well. While writing this review, the words “Marked” and “Markdown” appear over and over again, but justly so — the article is about them. I don’t need to see them in the list of overused words.

To edit the permanent list of words to highlight, choose Preview > Edit Keywords to bring up Marked’s Proofing preference pane. It has three tabs: Avoid, Use Alternate, and Other (which corresponds to the blue highlight mentioned above). Each gives you a ruled text field, so it’s simple to click inside to edit or add. If you screw up, you can restore the defaults for each.

[image link] [15]

Format and Export -- Marked not only previews text, it also formats text, according to a number of built-in themes. The default is Swiss, as indicated in the lower left of the preview window. Click the theme name to display a menu of eight themes, each with a keyboard shortcut. Special note to fiction writers: the Manuscript theme formats your document as though it came from a typewriter.

[image link] [16]

Not enamored of the defaults? You can create your own with standard CSS, if you’re familiar with styling Web pages. Create your style sheet as you would normally in BBEdit or CSSEdit or whatever, save it, and then, back in Marked, choose Marked > Preferences > Style. Click the + button and select your CSS file.

[image link] [17]

Custom CSS styles aren’t just a pretty way of viewing your documents. Once you’re previewing in Marked, you can copy out HTML or rich text, or export to PDF, .doc, .docx, and .odt. Be sure to turn off highlights first, or they’ll be embedded in your document! The conversion isn’t always perfect, but it offers a tantalizing look at a future where Markdown can easily be turned into any other format. It’s sort of like XML for humans.

[image link] [18]

You can view the HTML of your document at any time by selecting the angle brackets (<>) in the upper-right corner of Marked’s window.

Custom Preprocessors and Other Languages -- Marked can handle a variety of markup languages beyond Markdown and MultiMarkdown. It also supports the Fountain [19] screenwriting language, the CriticMarkup [20] editing standard, the aforementioned Leanpub [21] publishing service’s Markdown variant, the Mathjax [22] mathematics display engine, and the Discount [23] Markdown variant. Marked can even do tables of contents and chapter splits, so you could in theory use it to help build ebooks.

In addition to plain text documents, Marked can preview documents written in MarsEdit [24] and Scrivener [25], both of which emphasize content over form — though each has its own formatting and preview capabilities.

If you prefer some other markup language, never fear, because you can tie in custom processors [26] and preprocessors, which enable you to add additional languages or specific processing directives.

For instance, here at TidBITS, we have specified a custom variant of Markdown that allows the use of what we call “lazy links,” reference-style links that use asterisks in place of per-link labels. A bit of Perl code in the TidBITS Publishing System translates lazy links to regular reference links on the backend.

Lazy links may seem a bit nutty [27] to John Gruber, but they let us use Keyboard Maestro macros for automating link creation, make it easy to group links with their associated paragraphs, simplify editing and reordering links, and give us a more accurate preview of how our plain text email edition will look. (Want in on a secret? In the Web version of this article, click the pipe | between the category and date to see how we facilitate linking.)

But Marked doesn’t understand our lazy links out of the box. I contacted Brett Terpstra to ask him if he could add such support, and to my delight, he was nice enough to write a custom preprocessor [28] that does it for us! He even expanded it with the capability to include linked footnotes [29]. How’s that for customer service?

(Speaking of links, choosing Preview > Validate External Links is a great way to make sure all the links in an article work before going live with it.)

So no matter what markup language you use, if it can be translated to HTML, Marked should be able to handle it.

Power and Simplicity -- If I were forced to come up with a complaint, it would be that Marked’s design language sometimes clashes. For instance, the Detailed Statistics display features iOS 7-like thin text on a white background. But the temporary keyword editor uses a skeuomorphic notepad and switch, on a linen background — a throwback to iOS 6’s visual style. (Terpstra says he’s in the process of redesigning this.)

But that’s nitpicking. It’s incredible how much power has been tucked into what seems like such a simple app. If you compose serious text in Markdown or any of Marked’s other supported languages, Marked 2 is a must-have for its word repetition and statistics tools alone — not to mention many of the features [30] we didn’t get around to, such as adapting it for long-form reading.

But even more exciting, Marked’s powerful formatting and export capabilities take us closer to the day when human-readable, plain-text markup languages may largely supplant machine-readable, proprietary file formats for everyday uses. You probably won’t be able to design a brochure in Markdown or the equivalent, but for an article, script, manual, or novel, the combination of a lightweight markup language and Marked could eliminate the need for a complex word processor or page layout application. And the beauty of these plain text markup languages is that files using them can be opened on any platform, using many different apps. If you still have documents locked away in MacWrite or WriteNow format, you know how hard it can be to bring older files into the present.

So if you work with text, and certainly if you’re already doing much of your writing in Markdown, give Marked 2 a try. It has earned a permanent spot in my workflow, and, if it meets your needs as well, picking up a copy for $11.99 is a great way to show Brett Terpstra some appreciation for all the other Markdown-related tools he’s given away for free over the years.