Skip to content

Commit

Permalink
Update info on linter
Browse files Browse the repository at this point in the history
  • Loading branch information
juliasilge committed Nov 5, 2024
1 parent 8f3eb93 commit 5c78a47
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ jobs:
with:
fail_on_error: true
filter_mode: nofilter
reporter: github-pr-review
token: ${{secrets.GITHUB_TOKEN}}
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,4 @@ This project uses [Vale](https://vale.sh/docs/) for automated linting and compli
- If you are a Posit employee, you can find the "Posit Documentation Style Guide" on Confluence.
- If you are an external contributor, we as reviewers will take responsibility for compliance with the guidelines. Thank you for being willing to improve our docs!

Vale runs [via GH action on PRs](https://github.com/posit-dev/positron-website/actions/workflows/lint.yml), but you can also run it locally before you submit a PR if you have [installed Vale](https://vale.sh/docs/vale-cli/installation/) locally.

- First, use `quarto render` to generate the HTML that can be linted.
- Then, run `vale _site/` to lint the HTML generated by Quarto.
Vale runs [via GH action on PRs](https://github.com/posit-dev/positron-website/actions/workflows/lint.yml), but you can also run it locally before you submit a PR if you have [installed Vale](https://vale.sh/docs/vale-cli/installation/) locally. Run `vale .` from the root directory of this project to lint the `.qmd` files used to build to site.

0 comments on commit 5c78a47

Please sign in to comment.