Adds text linting, check & fix common misspellings (#12061)

This commit is contained in:
Franck Nijhof 2020-02-12 10:11:06 +01:00 committed by GitHub
parent 6cd47df8e2
commit 5488d9d0d7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 1534 additions and 25 deletions

View File

@ -26,6 +26,29 @@ jobs:
CI: true CI: true
- name: Run remark lint - name: Run remark lint
run: npm run markdown:lint run: npm run markdown:lint
textlint:
name: Lint Text
runs-on: ubuntu-latest
steps:
- name: Check out files from GitHub
uses: actions/checkout@v2
- name: Setting up Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: 12.x
- name: Setup NPM cache
uses: actions/cache@v1
with:
path: ~/.npm
key: npm-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
npm-
- name: Install dependencies
run: npm install
env:
CI: true
- name: Run textlint
run: npm run textlint
build: build:
name: Jekyll build name: Jekyll build
runs-on: ubuntu-latest runs-on: ubuntu-latest

8
.textlintrc.json Normal file
View File

@ -0,0 +1,8 @@
{
"filters": {},
"rules": {
"common-misspellings": {
"ignore": ["Proove", "Alot"]
}
}
}

1478
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,17 +1,21 @@
{ {
"name": "home-assistant.io", "name": "home-assistant.io",
"description": "Home Assistant Website & Documentation", "description": "Home Assistant Website & Documentation",
"version": "1.0.0", "version": "1.0.0",
"dependencies": {}, "dependencies": {},
"devDependencies": { "devDependencies": {
"remark-cli": "^7.0.0", "remark-cli": "^7.0.0",
"remark-frontmatter": "^1.3.2", "remark-frontmatter": "^1.3.2",
"remark-lint": "^6.0.5", "remark-lint": "^6.0.5",
"remark-lint-fenced-code-flag": "^1.0.3", "remark-lint-fenced-code-flag": "^1.0.3",
"remark-lint-no-shell-dollars": "^1.0.3", "remark-lint-no-shell-dollars": "^1.0.3",
"remark-stringify": "^7.0.3" "remark-stringify": "^7.0.3",
}, "textlint": "^11.6.3",
"scripts": { "textlint-rule-common-misspellings": "^1.0.1"
"markdown:lint": "remark --quiet --frail ." },
} "scripts": {
"markdown:lint": "remark --quiet --frail .",
"textlint:all": "textlint source",
"textlint": "textlint source/_cookbook source/_docs source/_faq source/_integrations source/_lovelace source/cloud source/getting-started source/hassio source/lovelace"
}
} }

View File

@ -15,16 +15,13 @@ The Garmin Connect sensor allows you to expose data from [Garmin Connect](https:
## Configuration ## Configuration
To add Garmin Connect to your installation, go to Configuration >> Integrations in the UI and enable the Garmin Connect integration by entering your credentials. To add Garmin Connect to your installation, go to Configuration >> Integrations in the UI and enable the Garmin Connect integration by entering your credentials.
After succesful login a standard set of sensors are enabled. After successful login a standard set of sensors are enabled.
You can enable more if needed by using the Integrations page. You can enable more if needed by using the Integrations page.
Please be aware that Garmin Connect has very low rate limits, max. once every ~10 minutes. Please be aware that Garmin Connect has very low rate limits, max. once every ~10 minutes.
## Available Sensors ## Available Sensors
Not every sensor holds meaningful values, it depends on the tracking device you use, and the apps you have connected. Not every sensor holds meaningful values, it depends on the tracking device you use, and the apps you have connected.
@ -73,7 +70,6 @@ Lowest Respiration
Latest Respiration Latest Respiration
``` ```
Disabled by default: Disabled by default:
```text ```text

View File

@ -46,7 +46,7 @@ language:
type: string type: string
default: "`en_US`" default: "`en_US`"
effect: effect:
description: "A dictionary of effects which should be applied to the speach output." description: "A dictionary of effects which should be applied to the speech output."
required: false required: false
type: map type: map
{% endconfiguration %} {% endconfiguration %}
@ -55,7 +55,7 @@ See [documentation](http://mary.dfki.de/documentation/index.html) for details.
## Speech effects ## Speech effects
For more information about the different effects take a look at the demo page of your MaryTTS installation (http://localhost:59125/). For more information about the different effects take a look at the demo page of your MaryTTS installation (`http://localhost:59125/`).
There you can read about each effect and also test them on the fly. There you can read about each effect and also test them on the fly.

View File

@ -50,15 +50,15 @@ api_key:
required: true required: true
type: string type: string
elevation: elevation:
description: The elevation of the monitored location; if ommitted, the value specified in `configuration.yaml` will be used. description: The elevation of the monitored location; if omitted, the value specified in `configuration.yaml` will be used.
required: false required: false
type: float type: float
latitude: latitude:
description: The latitude of the monitored location; if ommitted, the value specified in `configuration.yaml` will be used. description: The latitude of the monitored location; if omitted, the value specified in `configuration.yaml` will be used.
required: false required: false
type: float type: float
longitude: longitude:
description: The longitude of the monitored location; if ommitted, the value specified in `configuration.yaml` will be used. description: The longitude of the monitored location; if omitted, the value specified in `configuration.yaml` will be used.
required: false required: false
type: float type: float
{% endconfiguration %} {% endconfiguration %}