From 581de9f9ea75022ebe75278649a240f0608c27c1 Mon Sep 17 00:00:00 2001
From: Ravind Kumar <ravind@min.io>
Date: Tue, 1 Nov 2022 12:02:29 -0400
Subject: [PATCH] Attempting to enable github rendering of markdown (#623)

# Summary

The default Markdown parser MyST provides doesn't seem to like the way
we've designed our SDK Markdown docs.

This change *should* enable github-strict parsing. It also adds
auto-headers to all H1s, which might resolve some of the TOC issues.

This gives us some breathing room to fixup the SDKs where we can still
allow for the files to look good in GitHub, but know they will render
properly on our Sphinx-built docs.
---
 requirements.txt       | 4 +++-
 source/default-conf.py | 4 ++++
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/requirements.txt b/requirements.txt
index 31e539d7..56b66efe 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -7,4 +7,6 @@ Sphinx-Substitution-Extensions == 2020.9.30.0
 sphinx-sitemap == 2.2.0
 sphinx-togglebutton === 0.3.2
 sphinxcontrib-images === 0.9.4
-myst-parser === 0.18.0
\ No newline at end of file
+myst-parser === 0.18.0
+linkify === 1.4
+linkify-it-py === 2.0.0
\ No newline at end of file
diff --git a/source/default-conf.py b/source/default-conf.py
index d5b3a3be..9b993a7d 100644
--- a/source/default-conf.py
+++ b/source/default-conf.py
@@ -218,6 +218,10 @@ else:
 
 exclude_patterns.extend(excludes)
 
+# MyST Parser Customization
+myst_gfm_only = True
+myst_heading_anchors = 2
+
 # Copy-Button Customization
 
 copybutton_selector = "div.copyable pre"