From 8b65f81ae2f5b06290eedcd9579f6ad9bb020c00 Mon Sep 17 00:00:00 2001 From: James Couball Date: Mon, 16 Sep 2024 13:55:34 -0700 Subject: [PATCH] Standardize YARD and Markdown Lint configurations (#10) --- .markdownlint.yml | 25 +++++++++++++++++++++++++ .yardopts | 9 +++++++++ 2 files changed, 34 insertions(+) create mode 100644 .markdownlint.yml create mode 100644 .yardopts diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000..35fdd7d --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,25 @@ +default: true + +# Unordered list indentation +MD007: { indent: 2 } + +# Line length +MD013: { line_length: 90, tables: false, code_blocks: false } + +# Heading duplication is allowed for non-sibling headings +MD024: { siblings_only: true } + +# Do not allow the specified trailing punctuation in a header +MD026: { punctuation: '.,;:' } + +# Order list items must have a prefix that increases in numerical order +MD029: { style: 'ordered' } + +# Lists do not need to be surrounded by blank lines +MD032: false + +# Allow raw HTML in Markdown +MD033: false + +# Allow emphasis to be used instead of a heading +MD036: false diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..d82134b --- /dev/null +++ b/.yardopts @@ -0,0 +1,9 @@ +--no-private +--hide-void-return +--markup-provider=redcarpet +--markup markdown +--exclude examples/** +- CHANGELOG.md +- CONTRIBUTING.md +- RELEASING.md +- LICENSE.txt