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

WIP: adding a md linter to the lint process #41

Merged
merged 4 commits into from
Sep 9, 2024
Merged

Conversation

joshuafernandes
Copy link
Contributor

No description provided.

Copy link

vercel bot commented Aug 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-template ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 22, 2024 5:05am

@joshuafernandes joshuafernandes changed the title adding a md linter to the lint process WIP: adding a md linter to the lint process Aug 21, 2024
.editorconfig Outdated Show resolved Hide resolved
@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

trim_trailing_whitespace = true

[*.md]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Keep the config in the rules section so its one place

"jsx": true
},
},
rules: {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@m4sterbunny all the various rules to get things going. Have fixed up the bits in md/mdx as well so it now runs as part of the lint step

Copy link
Contributor

Choose a reason for hiding this comment

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

@joaniefromtheblock FYI Josh has setup some of the rules to get ES link going

- uses: actions/checkout@v4

- name: Vale
uses: ConsenSys/docs-gha/spelling@main
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@m4sterbunny If you merge #6 , or copy pasta the content as a branch directly into docs-gha ^ change the above line main to your branch's name and you can test things on this repo?

@joshuafernandes joshuafernandes merged commit 4370f95 into main Sep 9, 2024
11 checks passed
@joshuafernandes joshuafernandes deleted the lint-md branch September 9, 2024 21:38
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 this pull request may close these issues.

2 participants