From 28d7ab9a06c5adef2dc8f56d507e3a7b9f0f1ce0 Mon Sep 17 00:00:00 2001
From: CHAMI Rachid <chamirachid1@gmail.com>
Date: Tue, 19 Sep 2023 13:53:28 +0100
Subject: [PATCH] ci: add support for markdown lint (#206)

<!--
Please read and fill out this form before submitting your PR.

Please make sure you have reviewed our contributors guide before
submitting your
first PR.
-->

## Overview

Closes https://github.com/celestiaorg/quantum-gravity-bridge/issues/185

## Checklist

<!--
Please complete the checklist to ensure that the PR is ready to be
reviewed.

IMPORTANT:
PRs should be left in Draft until the below checklist is completed.
-->

- [ ] New and updated code has appropriate documentation
- [ ] New and updated code has new and/or updated testing
- [ ] Required CI checks are passing
- [ ] Visual proof for any user facing features like CLI or
documentation updates
- [ ] Linked issues closed with keywords
---
 .github/workflows/lint.yml | 5 +++++
 .markdownlint.yaml         | 5 +++++
 README.md                  | 2 +-
 3 files changed, 11 insertions(+), 1 deletion(-)
 create mode 100644 .markdownlint.yaml

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 1e4f3d4b..380aa72b 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -30,3 +30,8 @@ jobs:
             git diff
             exit 1
           fi
+  markdown-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: celestiaorg/.github/.github/actions/markdown-lint@v0.2.3
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
new file mode 100644
index 00000000..0a576746
--- /dev/null
+++ b/.markdownlint.yaml
@@ -0,0 +1,5 @@
+"default": true # Default state for all rules
+"MD010":
+  "code_blocks": false # Disable rule for hard tabs in code blocks
+"MD013": false # Disable rule for line length
+"MD033": false # Disable rule banning inline HTML
diff --git a/README.md b/README.md
index 6eb3a67c..3c8a6182 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
 [![GoDoc](https://img.shields.io/badge/godoc-reference-blue?style=flat-square&logo=go)](https://godoc.org/github.com/celestiaorg/quantum-gravity-bridge)
 [![Go Report Card](https://goreportcard.com/badge/github.com/celestiaorg/quantum-gravity-bridge?style=flat-square)](https://goreportcard.com/report/github.com/celestiaorg/quantum-gravity-bridge)
 [![Version](https://img.shields.io/github/tag/celestiaorg/quantum-gravity-bridge.svg?style=flat-square)](https://github.com/celestiaorg/quantum-gravity-bridge/releases/latest)
-[![License: Apache-2.0](https://img.shields.io/github/license/celestiaorg/quantum-gravity-bridge.svg?style=flat-square)](https://github.com/celestiaorg/quantum-gravity-bridge/blob/main/LICENSE)
+[![License: Apache-2.0](https://img.shields.io/github/license/celestiaorg/quantum-gravity-bridge.svg?style=flat-square)](https://github.com/celestiaorg/quantum-gravity-bridge/blob/master/LICENSE)
 
 The Quantum Gravity Bridge (QGB) is a Celestia -> EVM message relay.
 It is based on Umee's Gravity Bridge implementation, [Peggo](https://github.com/umee-network/peggo).