pypsa-meets-earth / documentation

Contains hackathon material, jupyter notebook visualizations and images
GNU General Public License v3.0
16 stars 68 forks source link

Harmonise requirements towards markdown formatting #53

Open ekatef opened 1 year ago

ekatef commented 1 year ago

Currently CI fails for every PR which introduces any changes into README. The reason in that requirements of github linter used do not quite match with README formatting. In particular, there are following points to be fixed:

Possible solution:

  1. Include markdown linter into pre-commit
  2. Change linter defaults
ekatef commented 1 year ago

A list of markdown linters can be extracted from a pre-commit list.

Defaults of Github Markdown linter are explained here.

An example of tackling a similar issue https://github.com/IBM/ibmi-oss-docs/pull/53