erlang / eep

Erlang Enhancement Proposals
http://www.erlang.org/erlang-enhancement-proposals/
264 stars 66 forks source link

Fix markdown mistakes #30

Closed garazdawi closed 3 years ago

garazdawi commented 3 years ago

I was looking through all EEPs and found a couple of markdown mistakes.

paulo-ferraz-oliveira commented 3 years ago

@garazdawi, it is possible to add some kind of Markdown validation to CI, via npm, for example. Let me know if you're interested and I might try to find time to tackle it. It's done for setup-beam FWIW.

garazdawi commented 3 years ago

markdownlint reports 2940 warnings in these markdown files :)

      1 MD031/blanks-around-fences
      1 MD034/no-bare-urls
      1 MD047/single-trailing-newline
      2 MD027/no-multiple-space-blockquote
      2 MD037/no-space-in-emphasis
      3 MD040/fenced-code-language
      3 MD046/code-block-style
      4 MD028/no-blanks-blockquote
      4 MD038/no-space-in-code
      5 MD033/no-inline-html
      5 MD036/no-emphasis-as-heading/no-emphasis-as-header
      7 MD024/no-duplicate-heading/no-duplicate-header
      7 MD026/no-trailing-punctuation
      7 MD029/ol-prefix
     13 MD001/heading-increment/header-increment
     22 MD032/blanks-around-lists
     57 MD041/first-line-heading/first-line-h1
     65 MD022/blanks-around-headings/blanks-around-headers
    122 MD007/ul-indent
    142 MD004/ul-style
    250 MD013/line-length
    256 MD003/heading-style/header-style
    258 MD010/no-hard-tabs
    271 MD030/list-marker-space
    416 MD009/no-trailing-spaces
   1016 MD012/no-multiple-blanks

If you would like to spend the time fixing them that would be most welcome :) Seems like most of them are space/newline related.

paulo-ferraz-oliveira commented 3 years ago

Oh, yeah, but you can configure this stuff so that some errors/warnings are not considered.