Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize YARD and Markdown Lint configurations #48

Merged
merged 1 commit into from
Sep 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
2 changes: 1 addition & 1 deletion .yardopts
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
--markup-provider=redcarpet
--markup markdown
- CHANGELOG.md
- LICENSE.txt
- LICENSE.txt