distincter2

GitHubActions codebeat badge Gem Version

About

A tool that can check lists in Markdown files and find duplicates.

How to use

You need to install distincter2 from RubyGems by next command:

$ gem i distincter2

After that, run distincter2 from any place with a path to your markdown files as parameter:

$ distincter2 ./path_to_directory_with_markdown_files

Config

Add .d2_config.d2c to root of your project and add excluded files line by line. Below you can find examples.

v1

Provides basic list for excluding files by names (without directories).

Add v1:

v1

BOOKS.md
DONE.md

Or without v1:

BOOKS.md
DONE.md

Documentation

You can generate documentation locally by next command from root of the project:

$ rdoc

How to contribute

Read Commit Convention. Make sure your build is green before you contribute your pull request. Then:

$ bundle exec rake

If you don't see any error messages, submit your pull request.

Contributors