Skip to content

Commit 1170f37

Browse files
authored
Enforce Markdown unordered list style (home-assistant#28172)
1 parent 613662d commit 1170f37

113 files changed

Lines changed: 1277 additions & 1255 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.remarkrc.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ var remarkrc = {
1414
["lint-no-shell-dollars"],
1515
["remark-lint-heading-increment"],
1616
["remark-lint-heading-style", "atx"],
17+
["remark-lint-unordered-list-marker-style", "-"],
1718
[
1819
"remark-lint-prohibited-strings",
1920
[

CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
2424
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
25+
- Focusing on what is best not just for us as individuals, but for the
2626
overall community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or
30+
- The use of sexualized language or imagery, and sexual attention or
3131
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
3535
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
- Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities

package-lock.json

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
"remark-lint-heading-style": "^3.1.2",
1212
"remark-lint-no-shell-dollars": "^3.1.2",
1313
"remark-lint-prohibited-strings": "^3.1.0",
14+
"remark-lint-unordered-list-marker-style": "^3.1.2",
1415
"remark-stringify": "^10.0.3",
1516
"textlint": "^13.3.3",
1617
"textlint-filter-rule-comments": "^1.2.2",

source/_docs/authentication/multi-factor-auth.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The Multi-factor Authentication (MFA) modules require you to solve a second chal
77

88
A password can be compromised in a number of ways, for example, it can be guessed if it is a simple password. MFA provides a second level of defense by requiring:
99

10-
* something you know, like your username and password, and
11-
* something you have, like a one-time password sent to your phone.
10+
- something you know, like your username and password, and
11+
- something you have, like a one-time password sent to your phone.
1212

1313
You can use MFA with any of the other authentication providers. If more than one MFA module is enabled, you can choose one when you log in.
1414

source/_docs/authentication/providers.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ name = John Doe
179179

180180
Leading and trailing whitespace, as well as lines starting with `#` are ignored. The following variables are supported. More may be added in the future.
181181

182-
* `name`: The real name of the user to be displayed in their profile.
182+
- `name`: The real name of the user to be displayed in their profile.
183183

184184
Stderr is not read at all and just passed through to that of the Home Assistant process, hence you can use it for status messages or suchlike.
185185

source/_docs/z-wave/controllers.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,9 @@ You should also check the README for details on the overlays. You might find it
128128

129129
This procedure has been tested with the following modules:
130130

131-
* Aeotec Z-Pi 7 Raspberry Pi HAT/Shield
132-
* Z-Wave.Me RaZberry 7
133-
* Z-Wave.Me RaZberry 7 Pro
131+
- Aeotec Z-Pi 7 Raspberry Pi HAT/Shield
132+
- Z-Wave.Me RaZberry 7
133+
- Z-Wave.Me RaZberry 7 Pro
134134

135135
1. Make sure the module is properly seated on the Home Assistant Yellow.
136136
![Aeotec Z-Pi 7 on Home Assistant Yellow](/images/docs/z-wave/zpi-7-yellow.jpg).

source/_includes/common-tasks/backups.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Backup of your Home Assistant and add-on data and configuration. They are stored
44

55
A full backup includes the following directories:
66

7-
* `config`
8-
* `share`
9-
* `addons` (only manually installed or created add-ons, not those installed from the store)
10-
* `ssl`
11-
* `media`
7+
- `config`
8+
- `share`
9+
- `addons` (only manually installed or created add-ons, not those installed from the store)
10+
- `ssl`
11+
- `media`
1212

1313
A partial backup consists of any number of the above default directories and installed add-ons.
1414

source/_includes/common-tasks/flashing_n2_otg.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,17 +63,17 @@ This will configure the ODROID-N2+ and OTG to act as a memory card reader:
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/).
66-
* Use the latest stable version of Home Assistant OS for the [ODROID-N2+](https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos['odroid-n2']}}/haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz) (haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz).
66+
- Use the latest stable version of Home Assistant OS for the [ODROID-N2+](https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos['odroid-n2']}}/haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz) (haos_odroid-n2-{{site.data.version_data.hassos['odroid-n2']}}.img.xz).
6767

6868
1. When the flash process is complete, disconnect the ODROID-N2+ from your PC.
69-
* Remove the power cable.
70-
* Remove the USB and HDMI cables.
71-
* Make sure to toggle the boot mode switch back to MMC.
69+
- Remove the power cable.
70+
- Remove the USB and HDMI cables.
71+
- Make sure to toggle the boot mode switch back to MMC.
7272

7373
1. Put the ODROID back in its case.
7474
1. Connect your ODROID-N2+ to your network with an Ethernet cable and plug in power.
7575

7676
1. If your router supports mDNS, you can reach your installation at `http://homeassistant.local:8123`.
77-
* If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of `homeassistant.local`. For example, `http://192.168.0.9:8123`.
78-
* You should be able to find the IP address of your ODROID-N2+ from the admin interface of your router.
77+
- If your network doesn’t support mDNS, you’ll have to use the IP address of your ODROID-N2+ instead of `homeassistant.local`. For example, `http://192.168.0.9:8123`.
78+
- You should be able to find the IP address of your ODROID-N2+ from the admin interface of your router.
7979
1. Continue with [onboarding](/getting-started/onboarding/).

source/_includes/installation/container.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ If you are using Docker then you need to be on at least version 19.03.9, ideally
1515

1616
Installation with Docker is straightforward. Adjust the following command so that:
1717

18-
* `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration and run it.
19-
* `MY_TIME_ZONE` is a [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), like `TZ=America/Los_Angeles`.
18+
- `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration and run it.
19+
- `MY_TIME_ZONE` is a [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), like `TZ=America/Los_Angeles`.
2020

2121
{% endif %}
2222

0 commit comments

Comments
 (0)