/dash-rubocop

Convert RuboCop doc to Dash, Zeal…

Primary LanguageRubyDo What The F*ck You Want To Public LicenseWTFPL

Convert RuboCop documentation to Dash

This repository contains a ruby script allowing one to convert the RuboCop manual for a given tag to a Dash compatible docset.

Dependencies

This script support modern rubies (> 2.5) and requires:

  • kramdown
  • kramdown-parser-gfm
  • nokogiri
  • rouge
  • sqlite3
$ gem install bundler
$ bundle install

How to use it

Just call the script with a git tag reference:

$ ruby convert_manual.rb <TAG>

For exemple:

$ ruby convert_manual.rb v0.82.0

It will work with commit id or branch name too, even if it’s not really necessarily. Because of a small internal trick, it won’t work with branch, which name contains a v. However, you should always use tags.