https://github.com/milouse/dash-rubocop
Convert RuboCop doc to Dash, Zeal…
https://github.com/milouse/dash-rubocop
Last synced: about 2 months ago
JSON representation
Convert RuboCop doc to Dash, Zeal…
- Host: GitHub
- URL: https://github.com/milouse/dash-rubocop
- Owner: milouse
- License: wtfpl
- Created: 2020-05-06T16:46:36.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-11T08:42:16.000Z (about 2 years ago)
- Last Synced: 2025-01-29T08:30:21.657Z (4 months ago)
- Language: Ruby
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- License: LICENSE
Awesome Lists containing this project
README
#+title: Convert RuboCop documentation to Dash
This repository contains a ruby script allowing one to convert the
RuboCop manual for a given tag to a [[https://kapeli.com/dash][Dash]] compatible docset.
* Dependencies
This script support modern rubies (> 2.5) and requires:
- kramdown
- kramdown-parser-gfm
- nokogiri
- rouge
- sqlite3
#+begin_src sh
$ gem install bundler
$ bundle install
#+end_src
* How to use it
Just call the script with a git tag reference:
#+begin_src sh
$ ruby convert_manual.rb
#+end_src
For exemple:
#+begin_src sh
$ ruby convert_manual.rb v0.82.0
#+end_src
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.