markdownlint: minor fixes
Refresh the markdownlint config from openbmc-build-scripts and make
fixes as recommended.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I754e9570c75538ee36c9e126bb24018c842c6b40
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
index 15c9e81..bcc4833 100644
--- a/.markdownlint.yaml
+++ b/.markdownlint.yaml
@@ -1,3 +1,6 @@
default: true
+MD013: false
MD024:
siblings_only: true
+MD033:
+ allowed_elements: ["br", "sub", "sup"]
diff --git a/README.md b/README.md
index 38932d2..143149b 100644
--- a/README.md
+++ b/README.md
@@ -88,7 +88,7 @@
### Associations
Entity Manager will automatically create associations between its entities in
-certain cases. For details see [here](docs/associations.md).
+certain cases. For details see the [associations doc](docs/associations.md).
## Requirements
diff --git a/src/gpio-presence/README.md b/src/gpio-presence/README.md
index 29ad1d2..91b2e5a 100644
--- a/src/gpio-presence/README.md
+++ b/src/gpio-presence/README.md
@@ -1,14 +1,14 @@
# gpio-presence-sensor
-This program was originally implemented following the design [1].
+This program was originally implemented following the [design][].
## Configuration
-See [1] for the full design.
+See the full [design][] for more details.
Example EM config fragments:
-```
+```json
{
Exposes:
[
@@ -54,7 +54,7 @@
The above configuration can then cause a Probe match in another configuration,
like below:
-```
+```json
{
Exposes:
[
@@ -92,5 +92,5 @@
## References
-- [1]
+[design]:
https://github.com/openbmc/docs/blob/master/designs/inventory/gpio-based-hardware-inventory.md