Skip to content

Commit

Permalink
Convert to AsciiDoc
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 and Rails style guides have been recently
converted:
  - rubocop/rspec-style-guide#97
  - rubocop/rails-style-guide#250
  • Loading branch information
pirj authored and bbatsov committed Jun 3, 2019
1 parent fc7b7e0 commit ba8bca8
Show file tree
Hide file tree
Showing 5 changed files with 4,699 additions and 4,665 deletions.
2 changes: 1 addition & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1 @@
*.md whitespace=trailing-space,tab-in-indent
*.adoc whitespace=trailing-space,tab-in-indent
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 ba8bca8

Please sign in to comment.