{"repo":"rubocop/rubocop-md","free":true,"listed":false,"github":"https://github.com/rubocop/rubocop-md","clone":"git clone https://github.com/rubocop/rubocop-md.git","description":"RuboCop for Markdown code snippets","language":"Ruby","stars":87,"topics":["rubocop","styleguide","markdown","ruby","hacktoberfest"],"license":"MIT","category":"dev-tools","readme_excerpt":"Rubocop Markdown Run Rubocop against your Markdown files to make sure that code examples follow style guidelines and have valid syntax. RuboCop Markdown is built by Evil Martians , an American design and engineering consultancy for developer tools, AI, and cybersecurity startups . Features - Analyzes code blocks within Markdown files - Shows correct line numbers in output - Preserves specified language (i.e., do not try to analyze \"\\ \\ \\ sh\") - Supports autocorrect 📝 This project was developed to keep test-prof guides consistent with Ruby style guide back in 2017. Since then, many popular Ruby projects adopted it, including: - Ruby on Rails - AnyCable - ViewComponent - Action Policy Installation Add this line to your application's Gemfile: And then execute: $ bundle install Or install it yourself as: $ gem install rubocop-md Usage Command line Just require rubocop-md plugin in your command: Autocorrect works too: Configuration Code in the documentation does not make sense to be checked for some style guidelines (eg Style/FrozenStringLiteralComment ). We described such rules in the default config, but if you use the same settings in your project’s .rubocop.yml file, RuboCop will override them. Fortunately, RuboCop supports directory-level configuration and we can do the next trick. At first, add rubocop-md to your main .rubocop.yml : Notice: additional options Secondly, create empty .rubocop.yml in your docs directory. Third, just run Also you can add special rules in the sec","default_branch":null,"files":null,"tree":[],"storefront":"/r/rubocop","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/rubocop/rubocop-md/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}