Skip to content

Instantly share code, notes, and snippets.

@teeparham

teeparham/rdoc2md.rb

Last active November 7, 2023 00:47
Show Gist options
  • Star 18 You must be signed in to star a gist
  • Fork 3 You must be signed in to fork a gist
  • Save teeparham/8a99e308884e1c32735a to your computer and use it in GitHub Desktop.
Save teeparham/8a99e308884e1c32735a to your computer and use it in GitHub Desktop.
Download ZIP
Convert rdoc to markdown
Raw
rdoc2md.rb
require 'rdoc'
converter = RDoc::Markup::ToMarkdown.new
rdoc = File.read(ARGV[0] || 'README.rdoc')
puts converter.convert(rdoc)
# ruby rdoc2md.rb > README.md
# ruby rdoc2md.rb ABC.rdoc > abc.md
Raw
rdoc2md.sh
alias rdoc2md='ruby ~/.ruby/rdoc2md.rb $1'
# rdoc2md > README.md
# rdoc2md ABC.rdoc > ABC.md
@michaelbrawn
Copy link

Thanks! I didn't get a perfect conversion, but it may have just been poor rdoc formatting to begin with.

@kojix2
Copy link

kojix2 commented Jan 29, 2019

@atz Thanks!

@tunggnu
Copy link

tunggnu commented Dec 25, 2020

@atz Thanks!

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