tactician icon indicating copy to clipboard operation
tactician copied to clipboard

RFC: Add markdown linting for `gh_pages`

Open pdelre opened this issue 3 years ago • 1 comments

👋 Would the maintainers be interested in PRs to improve the consistency of the markdown in the gh_pages branch for Hacktoberfest? I had worked previously with thephpleague/commonmark to introduce markdownlint Action and take passes on correcting any discovered issues (Change List).

If so, I'd add usage of DavidAnson/markdownlint (JS) as it integrates with VSCode, shell environments, as well as being used by GitHub's Super-Linter Action, further reducing the CI maintenance cost.

I created a small POC of how this would integrate with the gh_pages branch as it's different than thephpleague/commonmark's docs/ directory on main. You can review the results here.

image

pdelre avatar Oct 08 '21 15:10 pdelre

Hi, super late reply, but indeed, I'd be interested to have this. :)

rosstuck avatar Oct 24 '21 17:10 rosstuck