fixing linting

Consensys · Aug 22, 2024 · ada794d · ada794d
1 parent 4fed786
commit ada794d
Show file tree

Hide file tree

Showing 19 changed files with 1,090 additions and 971 deletions.
diff --git a/.eslintrc.md.js b/.eslintrc.md.js
@@ -14,13 +14,21 @@ module.exports = {
     // https://github.com/DavidAnson/markdownlint?tab=readme-ov-file
     "markdownlint/md001": "off",
     "markdownlint/md003": "warn",
+    // line length
     "markdownlint/md013": ["error", {
       "line_length": 100,
       "code_block_line_length": 100,
       "code_blocks": true,
     }],
+    // allow headings with the same content
+    "markdownlint/md024": "off",
+    // allow multiple ## and # in the same file
     "markdownlint/md025": ["error", {
-      "level": 2
-    }]
+      "level": 3
+    }],
+    // allow inline html
+    "markdownlint/md033": "off",
+    // allowed here, not for real docs
+    "markdownlint/md051": "off",
   }
 };
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -5,4 +5,4 @@ It's built using [Docusaurus](https://docusaurus.io/).
 
 It also contains a written guide for contributing to Consensys docs, and creating, configuring, and
 testing new doc sites, published at
-[`docs-template.consensys.net`](https://docs-template.consensys.net/).
+[`docs-template.consensys.net`](https://docs-template.consensys.net/).
diff --git a/docs/configure/google-analytics.md b/docs/configure/google-analytics.md
@@ -7,7 +7,8 @@ sidebar_position: 3
 # Configure Google Analytics
 
 Docusaurus supports [Google Tag Manager](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-tag-manager)
-and [GTag](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag) plugins for Google Analytics.
+and [GTag](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag)
+plugins for Google Analytics.
 The plugins are installed by default in this template repository.
 
 ## Set up Google Tag Manager and GTag

diff --git a/docs/configure/openapi.md b/docs/configure/openapi.md
@@ -6,6 +6,7 @@ sidebar_label: OpenAPI docs
 
 # Configure OpenAPI docs
 
-There are currently no plugins available to support Docusaurus 3. Please refer to the solution implemented on Web3signer
+There are currently no plugins available to support Docusaurus 3. Please refer to the
+solution implemented on Web3signer
 
 We will update this space when there is a plugin available from Redocusaurus or Palo Alto OpenAPI