Skip to content

Commit

Permalink
Convert the guide to AsciiDoc (rubocop#250)
Browse files Browse the repository at this point in the history
AsciiDoc allows us to have native admonitions, footnotes, sane nesting
of list items, etc and to easily export the guide in various formats.
That would also make it trivial to publish a simple site from the guide
down the road if we want to.

A longer term plan is to convert all guides to AsciiDoc and maybe even
RuboCop's own documentation.  RSpec style guide [has been recently
converted](rubocop/rspec-style-guide#97).
  • Loading branch information
pirj authored and bbatsov committed Jun 2, 2019
1 parent 7e326ac commit e8483be
Show file tree
Hide file tree
Showing 4 changed files with 1,544 additions and 1,572 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
README.html
README.pdf
4 changes: 0 additions & 4 deletions CONTRIBUTING.md

This file was deleted.

Loading

0 comments on commit e8483be

Please sign in to comment.