From 5920ba7a7082656275c13d82d7be76770cd14f0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javi=20Mart=C3=ADn?= Date: Mon, 17 Jun 2024 20:23:21 +0200 Subject: [PATCH] Remove rule MD033 Inline HTML MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We aren't following this rule in the `docs/es/features/graphql.md` file because we need to specify the HTML ID attribute of an element (since by default markdown generates IDs based on the text, and the text contains accented letters). Ideally we would simply ignore this rule on this file, but it isn't currently possible with Markdownlint, so, until we find a better solution, we're removing this rule. We've considered keeping the rule and using heading IDs like: ``` ## Características {#caracteristicas} ``` However, this syntax isn't supported by every application rendering markdown. For instance, github doesn't support it, and we're aiming to have a documentation that can be read on either github or gitbook. --- .mdl_style.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/.mdl_style.rb b/.mdl_style.rb index e433c1bcb..05507a584 100644 --- a/.mdl_style.rb +++ b/.mdl_style.rb @@ -2,6 +2,7 @@ all exclude_rule "MD013" exclude_rule "MD024" exclude_rule "MD029" +exclude_rule "MD033" exclude_rule "MD041" exclude_rule "MD046"