test markdown

[roidelapluie]

15:13:09 < roidelapluie> we should test Markdown
15:13:18 < roidelapluie> e.g multiple newlines

[igalic]

@roidelapluie wow, you're almost as bad at making issues as i am :P

---

basically, what i'm trying to say is: what do you mean, test markdown? and how should we do this? How does it belong into modulesync_config?

[roidelapluie]

We should add a test in .travis.yaml that could check the markdown files of the project for style errors

[igalic]

👍 💯 🎉

[juniorsysadmin]

Let's just use the mdl Ruby gem with a style file

[dhoppe]

Sounds great, even if it means we have a lot to fix. Just go to this issue and give the comment of @jyaworski a +1. ;)

[morremeyer]

You can use a workaround we also use:

desc 'Linting for all markdown files'
task 'markdown_lint' do
  require 'mdl'

  ARGV = [ 'site', 'documentation', 'README.md', ]
  MarkdownLint::run
end

However, it’s a really nasty one :/

[bastelfreak]

@mauricemeyer would you be interested in providing a PR to one of our modules that implements this? If it works, we can adopt it to this repo and roll it out to all modules.

[dhoppe]

I think the ARGV should be less static, because some of our modules provide a REFERENCE.md.

[morremeyer]

@bastelfreak We switched to DavidAnson/markdownlint as we needed the possibility to disable linting for certain sections/files.

As its in JS, I made our repository a pseudo-npm package for the sake of a simple npm install.

I’ll gladly provide a PR, but you’ll have to decide which of the two tools you want it implemented with.