Add markdownlint and tidy up markdown
#465
Conversation
paddyroddy
added
documentation
| # Benchmarking | ||
| ## Benchmarking |
There was a problem hiding this comment.
This type of change is because the title at the top of the page is essentially h1, so these should be h2
| <details> | ||
| <summary>Click to expand...</summary> | ||
| <details><summary>Click to expand...</summary> <!-- markdownlint-disable-line MD033 --> |
There was a problem hiding this comment.
Combining these, is just so we only have to have one markdownlint-disable-line
There was a problem hiding this comment.
That's the second time I've thought that these instructions should be moved/merged into CONTRIBUTING.md.
| @@ -58,6 +58,7 @@ def test_package_generation( | |||
| pathlib.Path(".github/workflows/linting.yml"), | |||
| pathlib.Path(".github/workflows/tests.yml"), | |||
| pathlib.Path(".gitignore"), | |||
| pathlib.Path(".markdownlint.yaml"), | |||
There was a problem hiding this comment.
This is required for the test to pass
|
What's the motivation for using this over just the |
This isn't formatting, it's linting |
|
What's the difference? |
For a bit more context on my question, this adds complexity to the setup here so it would be good to understand what the benefits of adding this are :) |
| [conda-badge]: https://img.shields.io/conda/vn/conda-forge/{{cookiecutter.project_slug}} | ||
| [conda-link]: https://github.com/conda-forge/{{cookiecutter.project_slug}}-feedstock | ||
| [pypi-link]: https://pypi.org/project/{{cookiecutter.project_slug}}/ | ||
| [pypi-platforms]: https://img.shields.io/pypi/pyversions/{{cookiecutter.project_slug}} | ||
| [pypi-version]: https://img.shields.io/pypi/v/{{cookiecutter.project_slug}} |
There was a problem hiding this comment.
These aren't being used (and picked up by markdownlint
It's adding more good practice so we don't accidentally break things. For example it will pick up that a file's first header is |
| <details> | ||
| <summary>Click to expand...</summary> | ||
| <details><summary>Click to expand...</summary> <!-- markdownlint-disable-line MD033 --> |
There was a problem hiding this comment.
That's the second time I've thought that these instructions should be moved/merged into CONTRIBUTING.md.
Using https://github.com/igorshubovych/markdownlint-cli which is my preferred way of managing https://github.com/DavidAnson/markdownlint