I was disappointed to find that there weren’t any good packages available for Sublime Text 2 that added decent Markdown editing features. I figured it was time to learn my way around. I still haven’t dug into Python, so my script-fu in there is weak right now. I got a few things working, though, and this will evolve as I learn new things. I’ll probably look back at this first version with embarrassment, but I’ll just overwrite it with better stuff as it progresses.

From the README on the Github repo:

This package will make MarkdownEditor your default theme for Markdown/MultiMarkdown files. Adjust it to your liking or remove the line from the .sublime-settings files

• Asterisks and underscores are autopaired and will wrap selected text
• If you start an empty pair and hit backspace, both elements are deleted
• If you start an empty pair and hit space, the right element is deleted
• backticks are paired
• Left bracket pairing is modified to eliminate the selection and leave the cursor at a point where you can insert a [] or () pair for a link
• ⌘⌥V will paste the contents of the clipboard as an inline link on selected text
• ⌘⌥R will paste the contents of the clipboard as a reference link
• ⌘K inserts a standard inline link, ⌘⇧K inserts an inline image
• ⌘B and ⌘I are bound to bold and italics (Markdown). If you don’t like losing your default shortcut for “Build”, modify the sublime-keymap file. This only overrides while editing Markdown files.

There’s a long way to go and I have a lot of Python to learn.

The theme pays some homage to Byword, but I make no pretense that it’s anywhere as pretty.

Installation

Just download or clone the MarkdownEditing repo into a MarkdownEditing folder within your ~/Library/Application Support/Sublime Text 2/Packages folder. You may have to restart Sublime to get it working, but once it’s installed (if all goes well), you should be able to open a Markdown file and see my custom theme. If you do, then the features listed above should also be available.

Right now, this is designed to be tweaked. I can’t guess what you’re preferred editing environment is like, so I went with mine. I’d love to see any permutations you come up with.

Oh, and by the way, if you’re doing any theming for Sublime Text, here’s a handy little plugin I whipped up to copy the scope of the character after the cursor to the clipboard for easily adding keys to a .tmtheme XML file:

Also check out Philip Belesky’s Byworded themes for TextMate and Sublime Text 2.

Related posts:

1. Auto-link text service updated
2. Markdown Service Tools 1.3
3. Markdown QuickTags: WordPress plugin for Markdown lovers

Originally posted on BrettTerpstra.com at Markdown Editing for Sublime Text 2: humble beginnings

1. Downloaded the iOS text editor spreadsheet as a CSV
2. Opened in Numbers for minor edits
   • Added a row of :-----: alignment syntax under first (header) row
   • Removed long text (HTML tables are a pain with wrapping and overflow)
3. Exported a new CSV with changes
4. Regex magic to convert CSV to MMD table (almost automatically, still 5 minutes of hand editing)
5. Applied basic CSS3 using inline <style> tags in the Markdown
   • turn empty cells dark grey
   • highlight any cell with content (minus first column) in green
   • cells with a full-width colspan (tailored to this table, 11 columns) turn lighter grey
6. Load it up in Marked and output the results with embedded style

Pretty pictures

The cleaned up spreadsheet in Numbers

The converted table in MultiMarkdown

(after using Fletcher’s table cleanup script)

The CSS:

table th {
	white-space:nowrap
}
table td:nth-child(n+2) {
	background: rgb(156, 230, 144);
	font-weight:bold;
	color:rgb(95, 191, 68);
	vertical-align:middle;
}
table td:empty {
	background: #777;
}
table td[colspan="11"] {
	background: #aaa!important
}

The hack Ruby CSV→MMD code:

#!/usr/bin/ruby
 
input = STDIN.read
 
# find quoted cells and replace commas inside quotes with placeholder
input.gsub!(/"([^,].*?)"/m) { |quoted|
	quoted.gsub(/[\n\r]*/,'').gsub(/,/,'zXzX')
}
# replace remaining commas with table divider (pipe)
input.gsub!(/,/,"| ")
# remove quotes from quoted cells
input.gsub!(/(\| |^)"(.*?)"/,"\\1\\2")
# replace placeholders with commas
input.gsub!(/zXzX/,",")
 
input.each { |l|
	puts "| #{l.strip} |"
}

The script takes input on STDIN, so to use it you pipe the contents of the CSV to it with cat:

cat myfile.csv | ~/scripts/csv2mmd.rb > outputfile.md

The result:

You can view a truncated version of the output here. Please note that this comparison chart is not complete and does not include even half the apps in the spreadsheet. It’s just for testing!

You can also see the raw MMD code here. It’s straight from the conversion script but has been run through Fletcher Penney’s table cleanup script to make it readable.

Related posts:

1. An average morning
2. A Service for writing MultiMarkdown footnotes inline
3. Quick Tip: clean up your MultiMarkdown tables

Originally posted on BrettTerpstra.com at Experiment: CSV to MMD tables with color coding

Screenshot of a Quick Look preview using the Upstanding Citizen style (available on the Github page):

I have found that some Markdown tools which come with their own Quick Look generators will always override my custom one, even when they aren’t the file’s owner (e.g. iA Writer). I don’t know how to get around this short of the brute force hack: open the Info.plist inside the qlgenerator file within the offending app’s bundle and delete the entry for net.daringfireball.markdown. That, or just delete the .qlgenerator bundle in the app entirely. That only works until the next time you upgrade, though, and it’s not recommended. If anyone knows a better solution, please shout.

Related posts:

1. Marked 1.3.1, more MultiMarkdown goodies
2. Notational Velocity and MultiMarkdown
3. Notational Velocity alternative MultiMarkdown version

Originally posted on BrettTerpstra.com at MultiMarkdown Quick Look with Style

I get a lot of one-off requests for scripts and tips on how to handle tasks specific to people’s workflow or writing style. I generally keep myself pretty busy, so I usually reply with a quick idea or thought and leave it up to them to run with it. David Coleman emailed me this morning, though, with a request that struck me as an interesting enough idea to whip up a script before work.

What David wanted to do was take the idea behind my “Inline Links to References” command in the Markdown Service Tools and do something similar for footnotes, allowing him to write footnotes inline in a paragraph and have them converted before processing with MultiMarkdown. It’s not such a chore to skip a few lines and drop in the footnote syntax that this should be part of the spec, but it is something I would find handy in several situations. So…

The format I picked uses a syntax like this to denote a footnote:

This is the regular text(*This is the footnote*), and you can drop the footnote in at any point.

The Service can handle footnotes inside of lines, at the end of lines, spanning multiple lines with breaks (creates paragraphs) and does fine with Markdown within the footnote. One nice thing about this syntax is that–if you’re previewing as you write–it italicizes the output to differentiate it until you’ve used the service to move it out of the main text.

Multi-line footnotes need to begin at the end of a line of text, and just use double-newlines to separate paragraphs within the footnote, e.g.:

...the end of the paragraph. (*This is a footnote

which is going to span

more than one line*)

Here’s the script, also available as a Service download at the end of the post.

Update: I just added a fix (in code below and the Service download) for making sure that footnote reference titles aren’t duplicated if you have existing MultiMarkdown-formatted footnotes in the document.

#!/usr/bin/env ruby
 
def e_sh(str)
	str.to_s.gsub(/(?=[^a-zA-Z0-9_.\/\-\x7F-\xFF\n])/n, '\\')
end
 
input = STDIN.read
 
footnotes = input.scan(/\(\*(.*?)\*\)/m)
existing = input.scan(/^\[\^fn(\d+)\]: /i)
counter = existing.empty? ? 1 : existing.uniq.sort[-1].join.to_i + 1
 
output = []
footnotes.each {|note| 
	output << {'orig' => note[0], 'title' => "fn#{counter}", 'footnote' => note[0] }
	counter += 1
}
 
o = []
output.each_with_index { |x,i| 
	o.push("[^#{x['title']}]: #{x['footnote'].gsub(/\n\n(\s*.)/,"\n\n\t\\1")}")
	input.gsub!(/\(\*#{e_sh x['orig']}\*\)/m,"[^#{x['title']}]")
}
puts input.strip + "\n\n#{o.join("\n\n")}\n"

I’m in San Francisco for an AOL Tech code jam right now, so I don’t have a lot of time to thoroughly test this. Please let me know about any bugs that need fixing.

If you’re in San Francisco and like coffee or beer, hit me up on Twitter. If you’re here for Macworld, then you’d better be at my “40 Tips in 40 Minutes” talk with David Sparks and Merlin Mann on Thursday!

Related posts:

1. Unwrap Paragraphs for the Markdown Service Tools
2. A better System Service for Evernote clipping — with MultiMarkdown
3. Natural Language Date Service update

Originally posted on BrettTerpstra.com at A Service for writing MultiMarkdown footnotes inline

Fixed

• More careful when stripping javascript from the document
• More responsive to a wider range of files/locations (Lion-only)
• Moved TOC to toolbar button
• Increased file size limit, offers a warning on large files

New

• Save/Copy as RTF
• Word count for selection
• Word repetition visualization
• Readability Statistics
• Keyboard navigation
  • help hud (press “h” in preview) for navigation keyboard shortcuts
• Option to disable SmartyPants typography extension
• Updated multimarkdown executable to development version
  • Better handling of HTML5 elements
  • Fix for bold/emphasis handling in complex blocks

The new location of the Table of Contents avoids a lot of overlap concerns. When there are headers (h2-h6) in the document, a button will appear next to the gear menu (to the left) and clicking it will slide up a list of those headers. Clicking a header in the list will navigate the document to that header and temporarily highlight it.

The increased file size limit will allow massive text files to be loaded, presenting a warning about decreased performance one time.

Save/Copy as RTF should be handy for people composing emails and other documents in Marked. It will maintain most aspects of the current custom style when creating the Rich Text version. The Copy as RTF has a little trouble with blockquotes right now, and I’m not sure I can do much about it, but beyond that it’s a quick way to get your preview into another document.

Word count for selection is pretty darn nifty: when you make a selection with the mouse, a small popup at the mouse cursor location will tell you the word and character count for just the selected text.

Word repetition visualization allows you to see words repeated by paragraph or across the entire document. You can click on a bolded (repeated) word and dim everything else so that it’s easy to see where the repetitions are located. It uses a stemming algorithm so that various forms of the same word are dectected, including plurals and conjugations.

The keyboard navigation is fairly extensive, with home-key controls for scrolling, the ability to use up to nine numeric bookmarks for rapid return, navigation by header and more. Pressing “h” in the preview will show all available shortcuts.

Fletcher Penney has been really great about providing some updates to the MultiMarkdown processor to handle a few edge cases. People who’ve experienced rendering anomolies should be quite satisfied!

Readability statistics are experimental, but Marked attempts to provide a grade level and Fog Index for your document.

There are a few new options in Preferences to cover some more requests for control over the preview and rendering. I’ve also updated the help system and added a Markdown reference you can keep open while working.

It’s a big release with a little version number… I’ll update the Marked website and post here as soon as it’s approved. Special thanks to the beta testers and their great feedback on this version. Also, if you buy Marked now, all of these features will be yours for free when the update comes out!

Related posts:

1. Marked is on the Mac App Store
2. Marked 1.3.1, more MultiMarkdown goodies
3. The second Marked giveaway!

Originally posted on BrettTerpstra.com at Marked 1.3.2 in review

There’s a new version of Marked on the horizon with a few new features, and one a little down the road with built-in support for more applications (that aren’t necessarily straight text editors). Enter for a promo code (by leaving a comment on this post) and you’ll have a chance at a free copy ($3.99). In addition to a fine app, winners will, of course, get free updates as they come out. Winners will be drawn at random from the comments on this post at noon on Saturday, December 3rd. Good luck!

Related posts:

1. Marked 1.3 drawing winners
2. Marked 1.3 released, plus 5 free copies!
3. Marked is on the Mac App Store

Originally posted on BrettTerpstra.com at The second Marked giveaway!

The latest version in development includes some really exciting new features:

• A HUD panel shows a list of labels that have been defined in your document that can be used when creating links, footnotes, citations, etc. This can be used to remind yourself of which label you used previously to define an element by reference. Another HUD panel shows word, paragraph, and character counts for your documents.
• A group of new key commands for selecting and moving parts of your document around without using the mouse, as well as for creating and cleaning up lists automatically.
• Composer now uses UTIs to define which documents it can open/save. This will have several behind-the-scenes benefits when it comes to saving, opening, previewing, and indexing documents for Spotlight searches.
• Significant improvements to responsiveness when working with long documents (e.g. using the ToC to scroll).
• Improved support for font-size and font-family in stylesheets. These will help my own themes work more smoothly.
• Plenty more!

Picking up a license now gets you free access to all of the new features when they’re released. Comment below for a chance at one of the five licenses (App Store US $9.99). Winners will be drawn at random (by the Giveaway Robot) on Thursday, December 1st at noon.

Notification is via email, so be sure to use a valid address. It’s also helpful to use a unique name (first and last preferred, but anything to help avoid duplicates) so announcements of the winners don’t get the other “Rob” or “Jim” all excited, only to be disappointed when they figure out it wasn’t them.

There are still a few more (very exciting) giveaways coming up over the next couple of days, so keep checking back. There’s no rule against entering for all of them (once each, please, or the robot gets angry. You don’t want to see him angry), so keep at it!

Related posts:

1. Mac App Giveaway: PDFpen
2. Marked is on the Mac App Store
3. Break up your text documents

Originally posted on BrettTerpstra.com at Mac App Giveaway: MultiMarkdown Composer

Marked 1.3.1 includes a few bugfixes but adds a surprising number of new features for an incremental version bump. See the changelog for a complete list, but here are the highlights:

• new icon!
• handles larger files
• recognizes CSS: and Base Header Level: metadata
• locates embedded scripts and includes them in the preview
• more keyboard shortcuts
• quick toggle for custom processor on a per-document basis.

If you’re already a Marked user, the update is in the Mac App Store right now. If you’re not, and you like the Markdown, you should probably check it out.

Related posts:

1. Marked 1.3.2 is live!
2. Marked is on the Mac App Store
3. Marked 1.3 released, plus 5 free copies!

Originally posted on BrettTerpstra.com at Marked 1.3.1, more MultiMarkdown goodies

I’ve been playing around with some themes for MultiMarkdown Composer, and thought I’d share a few that are turning out half decently. MultiMarkdown Composer’s syntax highlighting uses an extended version of the Peg Markdown Highlight format. You can add themes to ~/Library/Application Support/MultiMarkdown Composer/Styles (create it if it doesn’t exist) and they’ll show up in the Appearances preferences of MultiMarkdown Composer.

I wouldn’t call my initial attempts “awesome,” but they should be a good starting point for some ideas of your own. Note that you can add transparency to colors using an 8-digit hex format where the first two digits represent the alpha opacity. Take ‘em for a spin, let me know what you think, and be sure to share any modifications!

Another note… you can use these themes with editors like Mou, too, but you need to remove the extra MultiMarkdown-specific syntax at the end of each theme (tables, footnotes, etc.).

Related posts:

1. Mac App Giveaway: MultiMarkdown Composer
2. MultiMarkdown Composer hits the App Store
3. Quick Link: Bro Show #85

Originally posted on BrettTerpstra.com at A few themes for MultiMarkdown Composer

Fletcher Penney’s¹ latest project, MultiMarkdown Composer, is now available in the App Store. It provides a text editing environment with a full set of MultiMarkdown features. Unlike most of the other editors in this area, it auto-continues lists (ordered and unordered) and handles auto-pairing and wrapping. I’m working on a full review to post very soon, but I wanted to let you all know about it as soon as possible!

By the way, while it has one built in, it works even better with Marked as its preview! Check out MultiMarkdown Composer in the App Store ($7.99 intro price).

Related posts:

1. Mac App Giveaway: MultiMarkdown Composer
2. A few themes for MultiMarkdown Composer
3. Quick Link: Bro Show #85

Originally posted on BrettTerpstra.com at MultiMarkdown Composer hits the App Store

Marked 1.3 just made it up onto the Mac App Store! It incorporates a few fixes and some cool new features. So cool, in fact, that I raised the price to a whopping $3.99. I’m hoping the fact that it now functions as a mini web development tool and handles multiple custom styles makes it worth the extra buck to other folks, too.

The full changelog is up on the newly-revamped Marked website. Be sure to check out the snazzy new introductory video on the main page, too.

I’m thrilled that Marked has exceeded my initial sales expectations by 50x as of yesterday. As a thank you, I’m doing my own giveaway: 5 promo codes for a free copy of Marked. If you already own it, enter anyway and–if you win–give your promo code to a friend or family member you think could benefit from a full-featured Markdown utility! Just leave a comment about Marked below and I’ll do my usual super-random selection of 5 winners on Tuesday, October 11th at noon Central. Good luck!

By the way, if you want to file a bug report, suggest a feature or ask a question, be sure to visit the support site.

Related posts:

1. The second Marked giveaway!
2. Marked Bonus Pack fix and Marked 1.3 progress
3. Marked 1.3.1, more MultiMarkdown goodies

Originally posted on BrettTerpstra.com at Marked 1.3 released, plus 5 free copies!

The Bonus Pack currently includes scripts and commands for interacting with Marked from TextMate, Sublime Text 2, Emacs and Vim, as well as a System Service and AppleScript for opening the current file from Byword, TextEdit, Notational Velocity/nvALT and a fallback for just about any AppleScript-able application.

Once everything is smoothed out to my satisfaction, the Service will likely be included as part of the Marked application, but for now it’s a separate download. The next version of Marked (1.3) is in final beta testing with a few Snow Leopard bugs left to squash. I should be submitting it to the Mac App Store within the week.

Version 1.3 updates to the latest MultiMarkdown build, adds Lion Fullscreen, opens any file extension, handles multiple custom styles, adds a few nice touches (including MathJax) to previews and more. I’m really excited about it, I just want to make sure that all of the new features don’t bring an equal number of new bugs with them.

One feature I’m especially excited about in 1.3 is the ability to watch a custom style’s CSS file in addition to the Markdown (or HTML) file you’re editing. Not only does this make creating custom styles much easier, it also opens Marked up to being to web designers what it already is to Markdown writers: a live preview for your HTML/CSS, no matter what editor you’re working in. HTML5/CSS3 compatibility combined with the custom processor (which can be set to run the file through Ruby or PHP, too) makes it a handy addition to a web development toolkit. I’m using it to design a revamp to the Marked website right now, in fact.

If you haven’t checked out Marked yet, take a look at the Marked website. I went overboard collecting all of the nice things people were writing and made the page pretty ugly with the press section, but I’m working that out right now. I promise.

Related posts:

1. Introducing the Marked Bonus Pack
2. Marked Bonus Pack 1.2
3. Get Marked: 50% off for Black Friday

Originally posted on BrettTerpstra.com at Marked Bonus Pack fix and Marked 1.3 progress

I left it as the Perl version instead of the new PEG version because it was easier to embed, and allows me to force “snippet” rendering. Modify as you see fit, but this version makes a nice, neat package that does MultiMarkdown rendering without the need for any other installation. I thought others might find it useful, especially as an addition to Marked and nvALT capabilities, so here it is!

Download the service as part of the Markdown Service Tools package. See the how-to page on Installing System Services if you have questions!

Related posts:

1. Some Chrome love for the Markdown Service Tools
2. Unwrap Paragraphs for the Markdown Service Tools
3. Quick Tip: clean up your MultiMarkdown tables

Originally posted on BrettTerpstra.com at New Markdown Service tool: HTML to Clipboard

Marked 1.2 also adds niceties such as search, GitHub styles for editing readme.md files, and the ability to actually copy and paste from the preview and source views using standard shortcut keys (sorry that wasn’t there to begin with).

Here’s hoping that I fixed more than I broke in the process, and that you all enjoy the new release! Check out the Marked website for more info, and see the release notes for the full (and very long) list of what’s new!

Also, I’ll soon be unveiling a library of user-contributed custom styles, tips, tricks, scripts and System Services for making the most of Marked. If you have any of these that you’d like to contribute (with attribution, of course), let me know!

Related posts:

1. Marked 1.3 released, plus 5 free copies!
2. Marked Bonus Pack fix and Marked 1.3 progress
3. The second Marked giveaway!

Originally posted on BrettTerpstra.com at Marked 1.2 is out!

Well, my “secret” project is up and out: Marked was approved by Apple today for sale in the Mac App Store. It’s a Markdown previewer which can watch any text file for changes, updating the HTML preview whenever you save it. It adds Markdown preview to any text editor.

Marked has four built-in styles to suit most tastes, but you can also create your own custom CSS and tell Marked where to find it. Just export a document with lots of markup in it with the CSS embedded (check the box at the bottom of the Save dialog) and you’ll have a full structure to work with.

Marked can also print and print to PDF, and it maintains styling (without backgrounds) so you get professional, finished documents from your Markdown. As mentioned above, it also exports to HTML, with or without the preview styles. You can copy the HTML source as a snippet from your current document with a keystroke at any time (Command-Shift-C).

Marked’s preview panel can be “floated,” keeping it above all other application windows. You can also set a transparency level on it and have it become translucent when it’s not the foreground application.

There are document statistics, too, so if your text editor doesn’t have line, word and character counts, Marked has you covered. The word count is in the bottom bar of the window (you can hide it in preferences, if you want) and clicking it will give you a popup with other statistics.

I’m excited to have pulled this off. It’s not a huge application and it’s a really simple idea, but I got some good Objective-C experience and am proud of the result. Hopefully it will sell a few copies, too…

Check it out on the Mac App Store!

Related posts:

1. Marked 1.3.1, more MultiMarkdown goodies
2. Quick Tip: Extracting Mac App Store reviews as text
3. Marked Bonus Pack fix and Marked 1.3 progress

Originally posted on BrettTerpstra.com at Marked is on the Mac App Store