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

(feat): markdown linter #24

Merged
merged 2 commits into from
Jul 16, 2024
Merged

(feat): markdown linter #24

merged 2 commits into from
Jul 16, 2024

Conversation

SimonvanWijhe
Copy link
Member

No description provided.

@github-actions github-actions bot added enhancement New feature or request root release labels Jun 27, 2024
@SimonvanWijhe SimonvanWijhe force-pushed the feat/markdown-linter branch from d047056 to 2c5b443 Compare June 27, 2024 13:03
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 27, 2024
@SimonvanWijhe SimonvanWijhe force-pushed the feat/markdown-linter branch from b819e81 to e8e7186 Compare June 27, 2024 13:07
name: Markdown Linting
runs-on: ubuntu-latest
steps:
- uses: articulate/actions-markdownlint@v1

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try

Suggested change
- uses: articulate/actions-markdownlint@v1
- uses: DavidAnson/markdownlint-cli2-action@v16.0.0
with:
globs: '**/*.md'

@SimonvanWijhe SimonvanWijhe force-pushed the feat/markdown-linter branch 10 times, most recently from df1375e to 31eea3c Compare July 12, 2024 12:34
@SimonvanWijhe SimonvanWijhe requested review from a team, dtakken, robertbossaert, mvdhoek1, ictbeheer and projmunoz and removed request for a team July 12, 2024 12:43
@SimonvanWijhe SimonvanWijhe force-pushed the feat/markdown-linter branch from c66dbae to 4bd0b4a Compare July 12, 2024 13:16
@szepeviktor
Copy link

@SimonvanWijhe
Copy link
Member Author

All of my workflows: https://github.com/szepeviktor/byte-level-care/tree/master/.github/workflows

I’ll take a look at these. Thanks for sharing!

@szepeviktor
Copy link

I recommend you to leave the licence file alone: LICENSE.md -> LICENSE

@mvdhoek1
Copy link

I recommend you to leave the licence file alone: LICENSE.md -> LICENSE

Hi @szepeviktor, can you explain your recommendation?

@szepeviktor
Copy link

szepeviktor commented Jul 15, 2024

  1. the Markdown linter will not check it
  2. everyone names that file without an extension: 5.3M vs. 225k
  3. GitHub creates LICENSE with "Propose" button https://github.com/yardinternet/skeleton-package/community

@mvdhoek1
Copy link

  1. the Markdown linter will not check it
  2. everyone names that file without an extension: 5.3M vs. 225k
  3. GitHub create LICENSE with "Propose" button https://github.com/yardinternet/skeleton-package/community

@mvdhoek1 mvdhoek1 closed this Jul 15, 2024
@mvdhoek1 mvdhoek1 reopened this Jul 15, 2024
@SimonvanWijhe SimonvanWijhe force-pushed the feat/markdown-linter branch from 4bd0b4a to ab11cd1 Compare July 16, 2024 08:29
@SimonvanWijhe SimonvanWijhe merged commit 9880ea6 into main Jul 16, 2024
2 checks passed
@SimonvanWijhe SimonvanWijhe deleted the feat/markdown-linter branch July 16, 2024 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request release root
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants