elixir-docs-ru icon indicating copy to clipboard operation
elixir-docs-ru copied to clipboard

remark and editorconfig support

Open sobolevn opened this issue 7 years ago • 4 comments

I suggest to add some linting! I personally use remark and remark-lint quite successfully.

The reason behind it is simple: I like coding standards (I consider documentation as code too) and I like to automate things.

editorconfig is also very useful. It removes trailing spaces, converts tabs to spaces, and does many other things automatically. It is has plugins for every possible IDE or editor.

If everyone is fine with it:

  • [ ] I will add editorconfig file
  • [ ] I will add remark configuration (it may also check for dead links and many other things)
  • [ ] I will write .travis.yml file to test our docs
  • [ ] I will refactor failing parts to fit new rules

I am not sure about access rights. @jarosluv

sobolevn avatar Jul 27 '17 16:07 sobolevn

@jarosluv yeap, some issues with access rights. I can't even push to this project (not even master, I am using feature- branch). Could you please fix that?

sobolevn avatar Jul 27 '17 18:07 sobolevn

I have nothing against it of course

rtrv avatar Jul 28 '17 11:07 rtrv

@sobolevn

It's an awesome idea!

I try to fix your access issues. Please, check it.

jarosluv avatar Aug 04 '17 12:08 jarosluv

Received, thanks!

sobolevn avatar Aug 04 '17 13:08 sobolevn