Skip to content

Commit

Permalink
Standardize YARD and Markdown Lint configurations (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
jcouball authored Sep 16, 2024
1 parent d105374 commit 8b65f81
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
--no-private
--hide-void-return
--markup-provider=redcarpet
--markup markdown
--exclude examples/**
- CHANGELOG.md
- CONTRIBUTING.md
- RELEASING.md
- LICENSE.txt

0 comments on commit 8b65f81

Please sign in to comment.