Skip to content

Commit e4e0f96

Browse files
authored
Enforce Markdown headers are incremental (home-assistant#28158)
1 parent ce2fd10 commit e4e0f96

21 files changed

+203
-182
lines changed

Diff for: .remarkignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ _source/developers/credits.markdown
33

44
# Third party
55
sass/inuitcss/*
6+
LICENSE.md
67

78
# Changelogs are made out of commit messages
89
# We don't want to correct them

Diff for: .remarkrc.js

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ var remarkrc = {
1212
["frontmatter"],
1313
["lint-fenced-code-flag"],
1414
["lint-no-shell-dollars"],
15+
["remark-lint-heading-increment"],
1516
["remark-lint-heading-style", "atx"],
1617
[
1718
"remark-lint-prohibited-strings",

Diff for: package-lock.json

+18
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: package.json

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"remark-frontmatter": "^4.0.1",
88
"remark-lint": "^9.1.2",
99
"remark-lint-fenced-code-flag": "^3.1.2",
10+
"remark-lint-heading-increment": "^3.1.2",
1011
"remark-lint-heading-style": "^3.1.2",
1112
"remark-lint-no-shell-dollars": "^3.1.2",
1213
"remark-lint-prohibited-strings": "^3.1.0",

Diff for: source/_dashboards/energy.markdown

+12-12
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ At the moment there are no configuration options available for these cards, you
1818

1919
This card will allow you to pick what data to show. Changing it in this card will influence the data in all other cards.
2020

21-
#### Example
21+
### Example
2222
```yaml
2323
type: energy-date-selection
2424
```
@@ -33,7 +33,7 @@ type: energy-date-selection
3333
The energy usage graph card shows the amount of energy your house has consumed, and from what source this energy came.
3434
It will also show the amount of energy your have returned to the grid.
3535
36-
#### Example
36+
### Example
3737
```yaml
3838
type: energy-usage-graph
3939
```
@@ -47,7 +47,7 @@ type: energy-usage-graph
4747
4848
The solar production graph card shows the amount of energy your solar panels have produced per source, and if setup and available the forecast of the solar production.
4949
50-
#### Example
50+
### Example
5151
```yaml
5252
type: energy-solar-graph
5353
```
@@ -61,7 +61,7 @@ type: energy-solar-graph
6161
6262
The gas consumption graph card shows the amount of gas consumed per source.
6363
64-
#### Example
64+
### Example
6565
6666
```yaml
6767
type: energy-gas-graph
@@ -76,7 +76,7 @@ type: energy-gas-graph
7676
7777
The water consumption graph card shows the amount of water consumed per source.
7878
79-
#### Example
79+
### Example
8080
8181
```yaml
8282
type: energy-water-graph
@@ -95,7 +95,7 @@ If setup, it will also tell you how many kWh of the energy you got from the grid
9595
9696
If you set `link_dashboard` to `true`, the card will include a link to the energy dashboard.
9797

98-
#### Example
98+
### Example
9999
```yaml
100100
type: energy-distribution
101101
link_dashboard: true
@@ -111,7 +111,7 @@ link_dashboard: true
111111
The energy sources table card shows all your energy sources, and the corresponding amount of energy.
112112
If setup, it will also show the costs and compensation per source and the total.
113113

114-
#### Example
114+
### Example
115115
```yaml
116116
type: energy-sources-table
117117
```
@@ -125,7 +125,7 @@ type: energy-sources-table
125125

126126
The grid neutrality gauge card represents your energy dependency. If the needle is in the purple, you returned more energy to the grid than you consumed from it. If it's in the blue, you consumed more energy from the grid than you returned.
127127

128-
#### Example
128+
### Example
129129
```yaml
130130
type: energy-grid-neutrality-gauge
131131
```
@@ -139,7 +139,7 @@ type: energy-grid-neutrality-gauge
139139

140140
The solar consumed gauge represents how much of the solar energy was used by your home and was not returned to the grid. If you frequently return a lot, try to conserve this energy by installing a battery or buying an electric car to charge.
141141

142-
#### Example
142+
### Example
143143
```yaml
144144
type: energy-solar-consumed-gauge
145145
```
@@ -153,7 +153,7 @@ type: energy-solar-consumed-gauge
153153

154154
The carbon consumed gauge card represents how much of the energy consumed by your home was generated using non-fossil fuels like solar, wind and nuclear. It includes the solar energy you generated your self.
155155

156-
#### Example
156+
### Example
157157
```yaml
158158
type: energy-carbon-consumed-gauge
159159
```
@@ -167,7 +167,7 @@ type: energy-carbon-consumed-gauge
167167

168168
The self-sufficiency gauge represents how self-sufficient your home is. If you rely on grid imports, this value decreases. You can increase this value by adding more solar capacity or battery storage.
169169

170-
#### Example
170+
### Example
171171
```yaml
172172
type: energy-self-sufficiency-gauge
173173
```
@@ -181,7 +181,7 @@ type: energy-self-sufficiency-gauge
181181

182182
The devices energy graph show the energy usage per device, it is sorted by usage.
183183

184-
#### Example
184+
### Example
185185
```yaml
186186
type: energy-devices-graph
187187
```

Diff for: source/_dashboards/sidebar.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ type:
2525
type: string
2626
{% endconfiguration %}
2727

28-
#### Example
28+
### Example
2929

3030
Alternatively, the position of the card can be configured using YAML with the `view_layout` option:
3131

Diff for: source/_docs/configuration/customizing-devices.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If your entity is not supported, or you cannot customize what you need via this
2020

2121
By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
2222

23-
#### Possible values
23+
### Possible values
2424

2525
{% configuration customize %}
2626
friendly_name:
@@ -57,7 +57,7 @@ initial_state:
5757
default: None
5858
{% endconfiguration %}
5959

60-
#### Device Class
60+
### Device Class
6161

6262
Device class is currently supported by the following platforms:
6363

Diff for: source/_includes/common-tasks/flashing_n2_otg.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Home Assistant can be flashed to an ODROID-N2+ by connecting the device directly
44

55
_All these instructions work the same for the ODROID-N2 (non-plus version)._
66

7-
#### What you will need
7+
### What you will need
88

99
To flash your eMMC using Petitboot and OTG-USB, you will need the following items:
1010

@@ -13,7 +13,7 @@ To flash your eMMC using Petitboot and OTG-USB, you will need the following item
1313
- USB 2.0 to micro-USB cable
1414
- If your board came in a Home Assistant Blue: No.2 hex key to open the case
1515

16-
#### Enabling SPI boot mode
16+
### Enabling SPI boot mode
1717

1818
To enable the SPI boot mode:
1919

@@ -30,7 +30,7 @@ To enable the SPI boot mode:
3030
1. Connect a USB keyboard and a monitor (using HDMI) to your ODROID-N2+.
3131
1. Plug in the power cable to power on the ODROID-N2+.
3232

33-
#### Enabling USB drive mode
33+
### Enabling USB drive mode
3434

3535
After The ODROID-N2+ is set to SPI boot mode and powered on, it boots into a terminal. To enable the USB drive mode:
3636

@@ -59,7 +59,7 @@ This will configure the ODROID-N2+ and OTG to act as a memory card reader:
5959
ums /dev/mmcblk0
6060
```
6161

62-
#### Flashing Home Assistant
62+
### Flashing Home Assistant
6363

6464
1. Connect the ODROID-N2+ to your PC via the micro-USB port at the front of the ODROID-N2+.
6565
1. When the ODROID-N2 is recognized as a USB connected storage device, you can flash the eMMC with [Etcher](https://www.balena.io/etcher/).

Diff for: source/_integrations/airvisual.markdown

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo >
5151

5252
When configured, the platform will create three sensors for each air quality standard:
5353

54-
#### Air Quality Index
54+
### Air Quality Index
5555

5656
- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air.
5757
- **Example Sensor Name:** `sensor.chinese_air_quality_index`
@@ -67,13 +67,13 @@ AQI | Status | Description
6767
201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected
6868
301+ | **Hazardous** | Health alert: everyone may experience more serious health effects
6969

70-
#### Air Pollution Level
70+
### Air Pollution Level
7171

7272
- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI.
7373
- **Sample Sensor Name:** `sensor.us_air_pollution_level`
7474
- **Example Sensor Value:** `Moderate`
7575

76-
#### Main Pollutant
76+
### Main Pollutant
7777

7878
- **Description:** This sensor displays the pollutant whose value is currently highest.
7979
- **Sample Sensor Name:** `sensor.us_main_pollutant`

Diff for: source/_integrations/amcrest.markdown

+9-9
Original file line numberDiff line numberDiff line change
@@ -200,31 +200,31 @@ Available services:
200200
`start_tour`, `stop_tour`, and
201201
`ptz_control`
202202

203-
#### Service `enable_audio`/`disable_audio`
203+
### Service `enable_audio`/`disable_audio`
204204

205205
These services enable or disable the camera's audio stream.
206206

207207
Service data attribute | Optional | Description
208208
-|-|-
209209
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
210210

211-
#### Service `enable_motion_recording`/`disable_motion_recording`
211+
### Service `enable_motion_recording`/`disable_motion_recording`
212212

213213
These services enable or disable the camera to record a clip to its configured storage location when motion is detected.
214214

215215
Service data attribute | Optional | Description
216216
-|-|-
217217
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
218218

219-
#### Service `enable_recording`/`disable_recording`
219+
### Service `enable_recording`/`disable_recording`
220220

221221
These services enable or disable the camera to continuously record to its configured storage location.
222222

223223
Service data attribute | Optional | Description
224224
-|-|-
225225
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
226226

227-
#### Service `goto_preset`
227+
### Service `goto_preset`
228228

229229
This service will cause the camera to move to one of the PTZ locations configured within the camera.
230230

@@ -233,7 +233,7 @@ Service data attribute | Optional | Description
233233
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
234234
`preset` | no | Preset number, starting from 1.
235235

236-
#### Service `set_color_bw`
236+
### Service `set_color_bw`
237237

238238
This service will set the color mode of the camera.
239239

@@ -242,15 +242,15 @@ Service data attribute | Optional | Description
242242
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
243243
`color_bw` | no | One of `auto`, `bw` or `color`.
244244

245-
#### Service `start_tour`/`stop_tour`
245+
### Service `start_tour`/`stop_tour`
246246

247247
These services start or stop the camera's PTZ tour function.
248248

249249
Service data attribute | Optional | Description
250250
-|-|-
251251
`entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`.
252252

253-
#### Service `ptz_control`
253+
### Service `ptz_control`
254254

255255
If your Amcrest or Dahua camera supports PTZ, you will be able to pan, tilt or zoom your camera.
256256

@@ -260,12 +260,12 @@ Service data attribute | Optional | Description
260260
`movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down`
261261
`travel_time` | yes |Travel time in fractional seconds. Allowed values: `0` to `1`. Default: `0.2`.
262262

263-
#### Notes
263+
## Notes
264264

265265
- PTZ zoom capability does not control VariFocal lens adjustments.
266266
- There can be several seconds of lag before the video (snapshot or live) reflects the camera movement.
267267

268-
### Example card with controls
268+
## Example card with controls
269269

270270
<p class='img'>
271271
<img src='/images/integrations/amcrest/amcrest_ptz.jpg' alt='Screenshot using a picture-elements with PTZ controls.'>

Diff for: source/_integrations/doorbird.markdown

+4-4
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ See [Automation Example](#automation-example) section below for details on how t
5454
Events will not be received in Home Assistant until a schedule is defined via the DoorBird app.
5555
</div>
5656

57-
#### Clearing Registered Events
57+
### Clearing Registered Events
5858
Events can be cleared from DoorBird devices by visiting a special URL.
5959

6060
Simply open a new browser window and navigate to `{Home Assistant URL}/api/doorbird/clear?token={DEVICE_TOKEN}`. Replace `{Home Assistant URL}` with the full path to your running instance, such as `
@@ -64,7 +64,7 @@ Please note that clearing device events will require configuration steps above t
6464
<br><br>
6565
If DoorBird was setup using UI prompts, a token can be discovered through DoorBird App by clicking settings (cog icon) -> Administration-> LOGIN (using your App Administration details). Under the "FAVORITES" section, choose "HTTP(S) Calls". This displays all events and the associated HTTP URL. In that URL field, you will be able to see the token that was auto-generated by Home Assistant.
6666

67-
#### Event Data
67+
### Event Data
6868

6969
Each event will include live image and video URLs for the DoorBird device that triggered the event. These URLs can be found on the event data and are helpful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation.
7070

@@ -80,7 +80,7 @@ The following keys are available on `event_data`:
8080
The URLs on the event will be based on the configuration used to connect to your DoorBird device. The ability to connect from outside your network will depend on your configuration.
8181
</div>
8282

83-
#### Schedules
83+
## Schedules
8484

8585
Once events have been registered on the DoorBird device, they must be attached to a schedule using the official DoorBird app on Android or iOS or the [DoorBird - WebAdmin](https://webadmin.doorbird.com) portal. Currently, there are schedules available for doorbell, motion, relay, and RFID events (on supported DoorBird devices). Essentially, you can enable an HTTP(S) call from your DoorBird device to the Home Assistant DoorBird API by configuring an action/event (by enabling a schedule).
8686

@@ -98,7 +98,7 @@ On the desired event, you should be able to specify blocks of time for when you
9898

9999
Note: Remember to complete the schedule assignment steps above for each event type you registered. If you are configuring HTTP Call(s) schedules for registered RFID tags, please note that you will have to enable/configure the schedule for each RFID tag.
100100

101-
### Automation Example
101+
## Automation Example
102102

103103
The example automation below shows how to turn on a light when somebody presses the DoorBird call button:
104104

Diff for: source/_integrations/fastdotcom.markdown

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ manual:
5858
type: boolean
5959
{% endconfiguration %}
6060

61-
#### Time period dictionary example
61+
### Time period dictionary example
6262

6363
```yaml
6464
scan_interval:
@@ -70,7 +70,7 @@ scan_interval:
7070
milliseconds: 0
7171
```
7272

73-
### Service
73+
## Service
7474

7575
Once loaded, the `fastdotcom` integration will expose a service (`fastdotcom.speedtest`) that can be called to run a Fast.com speed test on demand. This service takes no parameters. This can be useful if you have enabled manual mode.
7676

Diff for: source/_integrations/harmony.markdown

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Start an activity. Will start the default `activity` from `configuration.yaml` i
6464
| `entity_id` | no | Entity ID to target.
6565
| `activity` | yes | Activity ID or Activity Name to start.
6666

67-
##### Example
67+
#### Example
6868

6969
In the file 'harmony_REMOTENAME.conf' you can find the available activities, for example:
7070

0 commit comments

Comments
 (0)