Skip to content

Commit cdbfb15

Browse files
author
tomas statter
committed
update readme, start using mdl to check md files
1 parent 481f88e commit cdbfb15

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

.spelling

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# markdown-spellcheck spelling configuration file
2+
# Format - lines beginning # are comments
3+
# global dictionary is at the start, file overrides afterwards
4+
# one word per line, to define a file override use ' - filename'
5+
# where filename is relative to this configuration file
6+
datashift
7+
paperclip
8+
gemfile
9+
thor
10+
libraoffice
11+
xls
12+
activerecord
13+
mp3
14+
json
15+
csv
16+
blogpost
17+
autotelik
18+
statter
19+
- README.md
20+
_spree
21+
BlogPostImport.csv
22+
_properties
23+
_to
24+
_many
25+
_one

md_style.rb

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
all
2+
3+
# https://github.com/mivok/markdownlint/blob/master/docs/RULES.md#md013---line-length
4+
# We exclude this rule because we believe it is easier to maintain the content
5+
# if there is no limit on line lengths. Most editors can wrap the text and
6+
# GitHub renders the content without issue. If we enforced a limit it would mean
7+
# when editing a paragraph contributors would not only need to edit the content,
8+
# but then also reformat it. We feel this last step is unnecessary.
9+
exclude_rule 'MD002'
10+
exclude_rule 'MD009'
11+
exclude_rule 'MD013'

0 commit comments

Comments
 (0)