search

libero / python-project-poc

Proof of concept for Libero python projects going forward
MIT License
0 stars 1 forks source link

Use markdownlint #2

Open de-code opened 5 years ago

de-code commented 5 years ago

Just to keep track of it (Visual Studio Code has it enabled by default and the README gets decorated with a few squiggly lines)

GiancarloFusiello commented 5 years ago

Intriguing. PyCharm has markdown linting also but does not show any errors. What are the linting errors you are seeing?

de-code commented 5 years ago

I believe it's using the same linter or rules I added here: https://github.com/libero/content-store-python/blob/master/check-markdown.sh

Most of them are spaces around things. Like headings and lists. And the code blocks should have a language specified (e.g. bash).

BTW personally I prefer using # e.g. to mark headings, as it saves me from trying to line up the =. But that's not a linting error, just a preference.

GiancarloFusiello commented 5 years ago

@de-code I've updated the read me to use # for headings and added the prompt type to triple quote command sections.

Regarding linting the README.md I would like other peoples input before added this.