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

Add wrapper for the markdownlint-cli2 action (OSOE-744) #289

Closed
BenedekFarkas opened this issue Nov 27, 2023 · 3 comments · Fixed by #351
Closed

Add wrapper for the markdownlint-cli2 action (OSOE-744) #289

BenedekFarkas opened this issue Nov 27, 2023 · 3 comments · Fixed by #351
Assignees

Comments

@BenedekFarkas
Copy link
Member

BenedekFarkas commented Nov 27, 2023

markdownlint-cli2 looks like the shortest path to standalone Markdown linting that doesn't rely on Lombiq.NodeJs.Extensions (which needs a solution to be built in).

The action is developed by the author of the markdownlint library, which is what Lombiq.NodeJs.Extensions uses as well.

Useful for documentation-heavy repositories, such as this one, so we don't have to wait for the OSOCE build to surface MD linting errors, similarly how this repository has its own spell checking.

Jira issue

@github-actions github-actions bot changed the title Add wrapper for the markdownlint-cli2 action Add wrapper for the markdownlint-cli2 action (OSOE-744) Nov 27, 2023
@Piedone
Copy link
Member

Piedone commented Nov 27, 2023

We don't need a separate issue for this, Lombiq/NodeJs-Extensions#11 covers this (that's also about having something outside of NE, it was only opened there because we initially thought it's most applicable to be done in NE). Please add this info there.

@BenedekFarkas
Copy link
Member Author

I see no mention of markdown there and Lombiq.NodeJs.Extensions already does MD linting. The wrapper (and the issue) belongs in this repo, that's exactly the point of this issue (not having to use Lombiq.NodeJs.Extensions).

@Piedone
Copy link
Member

Piedone commented Nov 27, 2023

Ah sorry, I was in the YML mindset. Yes, this is unrelated to Lombiq/NodeJs-Extensions#11 and valid here.

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

Successfully merging a pull request may close this issue.

2 participants