Skip to content

Commit 5368594

Browse files
authored
Upgrade markdown linter and fix documentation errors (#265)
1 parent fc57ca6 commit 5368594

File tree

5 files changed

+18
-25
lines changed

5 files changed

+18
-25
lines changed

.mdlstyle.rb

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
all
2-
rule 'MD013', :line_length => 1000
2+
rule 'MD013', line_length: 1000
3+
exclude_rule 'MD024' # Multiple headers with the same content
4+
exclude_rule 'MD046' # Code block style

CHANGELOG.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
* Use sprockets 3.x when running unit tests for Rails 4.2 ([#256](https://github.com/railsconfig/config/pull/256))
1313
* Cleanup example Rails application used for testing ([#263](https://github.com/railsconfig/config/pull/263))
14+
* Upgrade markdown linter and fix errors ([#265](https://github.com/railsconfig/config/pull/265))
1415

1516
## 2.1.0
1617

@@ -35,7 +36,7 @@
3536
### BREAKING CHANGES
3637

3738
After upgrade to dry-schema 1.0 we had to drop support for Rails `< 4.2` and Ruby `< 2.4`.
38-
If you need older version of Ruby or Rails, please stick to 1.x version of this gem.
39+
If you need older version of Ruby or Rails, please stick to 1.x version of this gem.
3940

4041
### New features
4142

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ appraisal rspec
2828
If you modified any of the documentation files verify their format:
2929

3030
```bash
31-
mdl --style .mdlstyle.rb *.md
31+
mdl *.md
3232
```

README.md

+11-21
Original file line numberDiff line numberDiff line change
@@ -466,8 +466,6 @@ You are very warmly welcome to help. Please follow our [contribution guidelines]
466466

467467
Any and all contributions offered in any form, past present or future are understood to be in complete agreement and acceptance with [MIT](LICENSE) license.
468468

469-
470-
471469
## Authors
472470

473471
* [Piotr Kuczynski](http://github.com/pkuczynski)
@@ -479,32 +477,24 @@ Any and all contributions offered in any form, past present or future are unders
479477

480478
### Code Contributors
481479

482-
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
483-
<a href="https://github.com/railsconfig/config/graphs/contributors"><img src="https://opencollective.com/rubyconfig/contributors.svg?width=890&button=false" /></a>
480+
This project exists thanks to all the people who contribute and you are very warmly welcome to help. Please follow our [contribution guidelines](CONTRIBUTING.md).
484481

485-
### Financial Contributors
482+
Any and all contributions offered in any form, past present or future are understood to be in complete agreement and acceptance with the [MIT](LICENSE) license.
486483

487-
[[Become a financial contributor](https://opencollective.com/rubyconfig/contribute)] and and support us with a small donation to help us continue our activities. Thank you if you already one! 🙏
484+
[![Contributors](https://opencollective.com/rubyconfig/contributors.svg?width=890&button=false)](https://github.com/railsconfig/config/graphs/contributors)
485+
486+
### Financial Contributors
488487

489-
#### Individuals
488+
[Become a backer](https://opencollective.com/rubyconfig#backer) and support us with a small monthly donation to help us continue our activities. Thank you if you already one! 🙏
490489

491-
<a href="https://opencollective.com/rubyconfig"><img src="https://opencollective.com/rubyconfig/individuals.svg?width=890"></a>
490+
[![Backers](https://opencollective.com/rubyconfig/backers.svg?width=890)](https://opencollective.com/rubyconfig)
492491

493-
#### Organizations
492+
#### Sponsors
494493

495-
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/rubyconfig/contribute)]
494+
Support this project by becoming a [sponsor](https://opencollective.com/rubyconfig#sponsor). Your logo will show up here with a link to your website.
496495

497-
<a href="https://opencollective.com/rubyconfig/organization/0/website"><img src="https://opencollective.com/rubyconfig/organization/0/avatar.svg"></a>
498-
<a href="https://opencollective.com/rubyconfig/organization/1/website"><img src="https://opencollective.com/rubyconfig/organization/1/avatar.svg"></a>
499-
<a href="https://opencollective.com/rubyconfig/organization/2/website"><img src="https://opencollective.com/rubyconfig/organization/2/avatar.svg"></a>
500-
<a href="https://opencollective.com/rubyconfig/organization/3/website"><img src="https://opencollective.com/rubyconfig/organization/3/avatar.svg"></a>
501-
<a href="https://opencollective.com/rubyconfig/organization/4/website"><img src="https://opencollective.com/rubyconfig/organization/4/avatar.svg"></a>
502-
<a href="https://opencollective.com/rubyconfig/organization/5/website"><img src="https://opencollective.com/rubyconfig/organization/5/avatar.svg"></a>
503-
<a href="https://opencollective.com/rubyconfig/organization/6/website"><img src="https://opencollective.com/rubyconfig/organization/6/avatar.svg"></a>
504-
<a href="https://opencollective.com/rubyconfig/organization/7/website"><img src="https://opencollective.com/rubyconfig/organization/7/avatar.svg"></a>
505-
<a href="https://opencollective.com/rubyconfig/organization/8/website"><img src="https://opencollective.com/rubyconfig/organization/8/avatar.svg"></a>
506-
<a href="https://opencollective.com/rubyconfig/organization/9/website"><img src="https://opencollective.com/rubyconfig/organization/9/avatar.svg"></a>
496+
[![Sponsors](https://opencollective.com/rubyconfig/sponsors.svg?width=890)](https://opencollective.com/rubyconfig)
507497

508498
## License
509499

510-
Config is released under the [MIT License](http://www.opensource.org/licenses/MIT).
500+
Copyright (C) Piotr Kuczynski. Released under the [MIT License](LICENSE).

config.gemspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Please consider donating to our open collective to help us maintain this project
4444
end
4545

4646
# Static code analysis
47-
s.add_development_dependency 'mdl', '~> 0.5', '>= 0.5.0'
47+
s.add_development_dependency 'mdl', '~> 0.8', '>= 0.8.0'
4848

4949
# Version 0.62 requires Ruby 2.2
5050
s.add_development_dependency 'rubocop', '~> 0.62'

0 commit comments

Comments
 (0)