Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC: Add markdown linting for gh_pages #155

Open
pdelre opened this issue Oct 8, 2021 · 1 comment
Open

RFC: Add markdown linting for gh_pages #155

pdelre opened this issue Oct 8, 2021 · 1 comment

Comments

@pdelre
Copy link

pdelre commented Oct 8, 2021

👋 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

@rosstuck
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants