Skip to content

Instantly share code, notes, and snippets.

@ttscoff
Last active April 3, 2025 19:48
Show Gist options
  • Save ttscoff/511174 to your computer and use it in GitHub Desktop.
Save ttscoff/511174 to your computer and use it in GitHub Desktop.
#!/usr/bin/env ruby
# Usage: tp2md.rb filename.taskpaper > output.md
# Updated 2025-03-19
# - Fix block quote indentation
# - use GFM-style - [ ] markers
# - convert @tags to #tags
# - <self-link> bare urls
# - Accept input piped on STDIN
if $stdin.stat.size.positive?
input = $stdin.read
title = "TODO"
else
input = File.read(ARGV[0])
title = File.basename(ARGV[0],'.taskpaper').capitalize
end
output = "# #{title} #\n\n"
prevlevel = 0
begin
input.each_line do |line|
if line =~ /^(\t*)(.*?):(?:\s*)$/
tabs = $1
project = $2
if tabs.nil?
output += "\n## #{project} ##\n\n"
prevlevel = 0
else
output += "#{tabs.gsub(/^\t/,'')}* **#{project}**\n"
prevlevel = tabs.length
end
elsif line =~ /^(\t+)?\- (.*)$/
task = $2
tabs = $1.nil? ? '' : $1
marker = task =~ /@done/ ? '- [x]' : '- [ ]'
if tabs.length - prevlevel > 1
tabs = "\t"
prevlevel.times {|i| tabs += "\t"}
end
tabs = '' if prevlevel == 0 && tabs.length > 1
output += "#{tabs.gsub(/^\t/,'')}#{marker} #{task.strip}\n"
prevlevel = tabs.length
else
next if line =~ /^\s*$/
tabs = ""
prevlevel.times {|i| tabs += "\t"}
output += "#{tabs}> #{line.strip}\n\n"
end
end
rescue => err
puts "Exception: #{err}"
err
end
output.gsub!(/(?mi)(?<!\]\(|\]: )\b((?:[\w-]+?:\/\/)(?:\S+?))(?=[\s\n)]|$)/, '<\1>')
puts output.gsub(/@(?=\S)/, '#')
@iansoper
Copy link

iansoper commented Aug 6, 2010

Very cool. Btw, where would I put the script? /usr/bin ?

@ttscoff
Copy link
Author

ttscoff commented Aug 6, 2010

I tend to keep scripts like this in a scripts folder off of my home directory (~/scripts) and put that directory in my path (in .bash_profile). If you wanted to make it executable (chmod a+x tp2md.rb) and stick it in /usr/local/bin, you could get away with that, too.

@ttscoff
Copy link
Author

ttscoff commented Aug 6, 2010

Note that it outputs the result to stdout, so you can redirect the output to anywhere you like (> filename.md) or pipe it to your Markdown processor directly (|/path/to/Markdown.pl)

@adetch
Copy link

adetch commented Dec 4, 2012

Any chance you have one that does it in reverse?

@mwiik
Copy link

mwiik commented Nov 19, 2013

I appreciate tp2md.rb and have come to rely on it but I don't know ruby at all myself. I note that the version of ruby shipped with OS X Mavericks isn't compatible with the required ftools gem. Any chance this could get an update? Thanks.

@ttscoff
Copy link
Author

ttscoff commented Mar 19, 2025

Updated for modern systems, see comments at top for changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment