search

iai-group / guidelines

IAI Style Guide
7 stars 4 forks source link

Consider using markdown linter #62

Closed IKostric closed 1 year ago

IKostric commented 1 year ago

Very popular and configurable markdown linter available as a vscode extension.

kbalog commented 1 year ago

The question is: can it be configured to follow our markdown guidelines?

IKostric commented 1 year ago

It is possible to disable any rule we disagree with. The only one I currently have disabled is for the list style where we specify:

Top-level lists are marked by *, second, third, etc. levels below are marked by -.

Alternative to disabling the rule, these are available.

kbalog commented 1 year ago

It should also be possible to control the list indentation: https://github.com/DavidAnson/markdownlint/blob/main/doc/md007.md

Please create an issue to extend our guidelines with the use of this.

IKostric commented 1 year ago

As mentioned in the previous comment, nested lists cannot be changed to follow our desired format.

Our specification:

  *
    -
      -

The closest we can get:

  *
    -
      +

Should we disable the rule for nested lists or update our guidelines?

kbalog commented 1 year ago

We can update our guidelines to use + on the 3rd level. Do mention this at the next IAI meeting though.