-
Notifications
You must be signed in to change notification settings - Fork 127
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
58 changed files
with
1,242 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: Check Docusaurus docs with Vale linter | ||
|
||
on: [pull_request] | ||
|
||
jobs: | ||
vale: | ||
name: Vale doc linter | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/[email protected] | ||
|
||
# Set up Vale Action | ||
- uses: errata-ai/[email protected] | ||
with: | ||
# Filter mode can be set to: added, diff_context, file, nofilter | ||
filter_mode: nofilter | ||
# Set the reporter to display the output: github-pr-check, github-pr-review, github-check | ||
reporter: github-pr-check | ||
# Fails the action if there are errors | ||
fail_on_error: true | ||
# Lint the files in the "versioned_docs/version-2.0.0/" directory | ||
files: 'versioned_docs/version-2.0.0' | ||
# Specify the Vale version | ||
version: 3.0.3 | ||
env: | ||
# GitHub token for authentication, automatically set by GitHub Actions | ||
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# vale.ini | ||
|
||
StylesPath = vale_styles # Update this path to where your styles are stored. | ||
MinAlertLevel = error # Set the minimum alert level to display (suggestion, warning, or error). | ||
Vocab = Base | ||
|
||
[*.md] | ||
# Enable Markdown-specific styles. | ||
BasedOnStyles = Vale, Google | ||
|
||
# Customize specific rules based on your needs. | ||
List.Capitalization = YES | ||
|
||
# Override some rules: | ||
Vale.Spelling = YES | ||
Google.PassiveVoice = NO # Disable passive voice rule if unnecessary | ||
Google.We = NO # Disable first-person plural flagging | ||
Google.Will = NO # Allow "will" usage | ||
Google.Exclamation = NO # Allow exclamation points | ||
Google.Ellipses = NO # Allow ellipses in text | ||
Google.Latin = NO # Allow "e.g." and "i.e." instead of "for example" | ||
|
||
# Allow specific terms: | ||
Vale.Terms=NO | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.