Brett Terpstra:

The initial release of CriticMarkup included a preprocessor for Marked 1.5+, but given the uncertain release date of the next incarnation of Marked, I wanted to make it work with the standard custom processor feature of Marked 1.4. A few adjustments to the existing script and one dependency later it’s good to go.

I use CriticMarkup whenever I need to track changes in a MultiMarkdown document. I launch Marked (from Sublime Text 2) on a daily basis to preview my articles and generate HTML, so it’s good to know the two systems can work together now.

Apr
9
2012

What started out as a companion app aimed at tech bloggers writing articles in Markdown has become a multipurpose Swiss Army knife for previewing scripts, stories, and code for writers and programmers. While Marked has always fulfilled my needs for finalizing drafts, copying HTML output into a web editor, and checking to see if I’ve overused various positive adjectives, the latest version adds an abundance of new features that make previewing articles in realtime even more useful. It’s important to note that Marked 1.4 is compatible with Lion only — Snow Leopard and Leopard users won’t be able to take advantage of the latest features.

What’s useful to bloggers:

Three changes have a direct effect on my workflow: Scroll to first edit, which moves the document to the current edit point when changes are detected; HTML highlighting, which makes scanning HTML output easier than before; and popovers on external links, which will bring up options to copy and validate a link. The first two new features work splendidly, with Marked scrolling to the paragraph where I’ve added a link or changed a sentence once I’ve left the focus of TextEdit (my editor of choice) or save manually with ⌘S.

Unfortunately, link popovers don’t work as expected. Instead of hovering the mouse over a link, clicking on the link brings up a popover with the copy, validate, and open-in-Safari options. Link validation in particular is great as it provides a quick way to check a slew of links without having to leave the Marked preview (especially useful if you use [this]: style of link in Markdown). Once the link has been clicked on for the popover, clicking it a second time takes you to the website in your default browser. It seems whether the popover is shown depends on whether the URL has already been checked (document-wide).

A fourth new feature bloggers will love if they’ve written their own Marked styles to match the format of their websites will be per-document styles. Instead of changing the style through the GUI, you can include a brief piece of metadata at the beginning of your document by adding the following: “Marked Style: Your preferred style here” (without quotes). If you create new documents with shortcuts or triggers, you can further automate how it will look in Marked by adding a snippet of metadata — useful when you publish or want to see output for a specific blog. The metadata you add is excluded from the HTML output. HTML output, by the way, has a new toggle in the titlebar.

Lastly, for bloggers concerned about their HTML output, Marked now gives you the option to disable header ID creation. Unless you have a specific need for styling, there’s no reason to have Marked generate an ID per header. I’ve definitely enabled this one.

What’s useful to writers and screenwriters:

Scrivener 2.x projects and Leanpub files are now supported by Marked. Scrivener projects, like .md or .txt files, can simply be dragged into Marked and compiled to provide a live preview of your working content. Pressing ⌘E (open in editor) will take open .scriv files being previewed in Scrivener if you’re reviewing your script and need to make a live change. As you write and save your document, Marked will reflect the changes made.

Leanpub compatibility is a little bit harder to explain. What Marked will allow writers to do with their Leanpub files is merge and compile them so that the documents can be previewed and navigated via a table of contents. To take advantage of this feature, an Index.md file is created and requires that the first line be “frontmatter:” (again without quotes) signifying the Leanpub format. In the Index.md file, you’ll need to add your Leanpub files as sections using a special syntax that’s separated by Markdown headers to designate the book title, chapters, etc. This help page should give you a better handle on how to use Leanpub and multi-file documents with Marked.

Having commented on using table of contents, it’d be wrong of me not to mention its fantastic new search feature. After pressing ⌘T to show the table of contents (which basically groups all of the headers in a Markdown document into a list), you can tap the space bar to quickly type a chapter number or section title. Using the arrow or J/K keys, you can select the section before pressing escape to continue previewing your document. It’s a quick and keyboard friendly way to jump around an expansive document.

What’s useful to programmers:

Programmers get their own automatic syntax highlighting update for code blocks. I found that while it worked well with Marked’s default preview, syntax highlighting often had undesirable results when high contrast was enabled. Highlighting itself is taken care of thanks to highlight.js.

Programmers will also appreciate the ability to create fenced code blocks, which are delimited by tildes or backticks. Languages can be specified, but highlight.js will try to automatically detect one of its 41 supported languages on its own.

For those creating GitHub readmes, the GitHub style has been updated to reflect the most recent changes on the site. In the preferences, a new option has also been added to preserve line breaks in paragraphs, mimicking GitHub’s style if you choose to enable it.

Other changes:

Two new themes have been added to Marked: Amblin and Upstanding Citizen. Amblin, laid-back and traditional, is a polar opposite of Upstanding Citizen’s bold centered headers and condensed paragraphs. Amblin is great for writing cozily late into the night — it’s ousted Swiss for me as far as the default styles go.

The preferences panes are all brand new — options are easy to find and are nicely separated into convenient sections. If you plan on printing documents, you can force page breaks with a break snippet, by using horizontal rulers, or before H1 and H2 headers (this printing section should give you a quick primer on the options you have available).

No longer catering to just mainstream tech reporters, Marked has expanded its role from a nerdy Markdown utility to a polished, multipurpose tool that’s bent on making sure any craftsman of words can output a good looking document. More than just a preview app, Marked is feature rich without being complex, presenting files as you want them while providing numerous ways to do simple things from copying text to getting HTML output of your files. Support for Leanpub and Scrivener only adds usefulness for authors using Macs to produce upcoming books, and screenwriters can look forward to added compatibility with Fountain in the future.

Marked provides a lot in an accessible package, and for only $3.99 it’s a steal for anyone who works with Markdown files and its derivatives. You can check out Marked online and download it from the Mac App Store.

Folks who enjoy writing in Markdown have already installed Brett Terpstra’s fantastic Marked for Mac, a nifty utility to generate HTML previews from Markdown documents written in any OS X application. You can read our review of version 1.2 here. Those who prefer a more cohesive writing environment with plain text/Markdown and HTML output living in the same application, however, might want to take a look at MarkdownNote, a new entry in the Markdown editing space that’s got some interesting features.

MarkdownNote has been available for quite some time on the iPad, and it’s now jumped over to the Mac with a feature set that takes advantage of Lion’s full-screen, Resume and Versions. MarkdownNote’s distinctive functionality is “live preview”, a split interface that lets you write in plain text with Markdown on the left, and have another panel immediately format Markdown as HTML on the right. This happens as-you-type, and with Markdown’s **strong** and *italic* formatting options you’ll only have to properly close such “tags” for the preview to refresh accordingly. MarkdownNote has a menu on the bottom left to resize the panels for Markdown and Live Preview, with options to set the editor and preview at 50, 70 or 100 percent.

MarkdownNote can save .txt files (everyone loves plain text, right?) , it lets you pick your own font and it’s got some further options to play with in the Preferences. When you’re done writing, you can copy the HTML and paste it somewhere else as usual. I’ve found MarkdownNote to be extremely useful in full-screen mode, as the split interface makes for a great alternative to having large borders around your text — with this app, you don’t waste space and you’ve got a live-updating preview at the same time.

MarkdownNote and Marked

Best of all, MarkdownNote works great with Brett’s Marked, although you may wonder why would anyone use Marked when MarkdownNote has got a live preview. I think MarkdownNote is great at letting you write and quickly keep an eye on the correct visual output, but I still prefer Marked for editing — after I’ve written a long piece, I fire up Marked, choose my favorite style, see how many words I’ve typed, and I go through my Markdown. I love this combination of writing tools.

At $3.99 on the Mac App Store, MarkdownNote gives you an easy way to write in Markdown and instantly see how the words you typed will look like, and use keyboard shortcuts to facilitate the process of Markdown writing itself. MarkdownNote works really well in combination with Lion’s full-screen mode and Marked — if you’re a Markdown nerd, you should give this a try.

Aug
19
2011

This one goes out to all the Markdown nerds out there (I’m one of them). Marked 1.2 is out, and it’s packed with tons of new features. The interface should be pretty familiar, although you have to like the new persistant word count that you can toggle on and off. CSS styles have been changed up a bit (if you’re not using your own — I used Horizon which is similar to the multi-column style), but asides from the tweaks on the surface of Marked, we have some usability improvements that should make everyone really happy.

Directly interact with the preview and source code using standard highlighting and copy shortcuts to grab text and quickly paste it in the application or web service of your choice. Bundled inside is a new MultiMarkdown 3 binary that’s efficient and better handles big files (for those writing another “Hitchhikers Guide to Markdown” manual), along with web document presentation and compatibility for everything from HTML and ERB (that’s Ruby shenanigans for those wondering). Hit command+E to edit text in your favorite editor, or find where you put down the Master Sword with command+R to bring the file into view from the Finder. Not geeky enough? Marked does a better job of knowing where you are in the document, and will even follow along if you’ve reached the bottom of the page. You can limit text width in the preview, supress link highlighting if you’re going to print (yes, printers till exist), and opening new preview windows can be opened to float on the desktop.

That’s just scratching the surface of what’s available in Marked if you write in Markdown — I use it on a daily basis here at MacStories, and I’m sure you fellow Geekstorians will find it just as useful. Check out the changelog to Marked (it is MASSIVE), read Brett Terpstra’s update, and check it out on the Mac App Store (it’s only $2.99).

Forget fancy formatting: Why plain text is best

Although modern word processing programs can do some amazing things—adding charts, tables, and images, applying sophisticated formatting—there’s one thing they can’t do: Guarantee that the words I write today will be readable ten years from now. That’s just one of the reasons I prefer to work in plain text: It’s timeless. My grandchildren will be able to read a text file I create today, long after anybody can remember what the heck a .dotx file is.

David Sparks from the wonderful MacSparky blog and Mac Power Users has made a debut post on Macworld with a great discussion on working with plain text files (I also believe Patrick Rhone talks about this and information silos in his Minimal Mac podcast, Enough).

I’ve been increasingly using TextEdit with Marked for writing everything that shows up on the website, and I know Federico recently put Byword (in combination with OmniOutliner) to the test with his great MacBook Air review. No matter what tools I use, whether it be TextMate, iA Writer, or another app, I’m always writing in Markdown and writing in text files. These text files are saved in Dropbox or some temporary workspace (which I consider to be my alternate directory to the Desktop).

Honestly, the best way to get started with plain text before you invest in another app is to simply open up TextEdit, hit ⇧⌘T, and start typing. David makes a strong case for nvALT, which you might like better since you can have the best of both worlds: accessible plain text files in the file system in a big container that makes it easy to search through everything you’ve written (as a bonus, these files can be tagged and synced to your iPad and iPhone via Simplenote).