From 91040be514ae9ef00d4c688ab37e7a26118cef6f Mon Sep 17 00:00:00 2001
From: John Bachir <jjb@users.noreply.github.com>
Date: Wed, 27 Mar 2024 22:33:48 -0400
Subject: [PATCH 1/2] documentation about markdown providers

closes #1410
closes #1543
---
 README.md | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/README.md b/README.md
index ec5ffc997..2d0d480a2 100644
--- a/README.md
+++ b/README.md
@@ -122,6 +122,13 @@ HTML. If running `which rdoc` turns up empty, install RDoc by issuing:
 $ sudo apt-get install rdoc
 ```
 
+### Markdown parser
+
+When rendering markdown, yard will use one of several possible markdown providers,
+[in order of priority](https://github.com/lsegal/yard/blob/e833aac7a01510245dd4ae1d1d18b046c8293c2d/lib/yard/templates/helpers/markup_helper.rb#L26-L33).
+If you are experiencing rendering bugs (#1410, #1543), try adding one of the
+gems further up in the list to your Gemfile.
+
 ## Usage
 
 There are a couple of ways to use YARD. The first is via command-line, and the

From d29ce254c0b466df0a2195730a62092fd1fd202c Mon Sep 17 00:00:00 2001
From: John Bachir <jjb@users.noreply.github.com>
Date: Wed, 27 Mar 2024 22:38:43 -0400
Subject: [PATCH 2/2] Update README.md

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2d0d480a2..652162888 100644
--- a/README.md
+++ b/README.md
@@ -126,7 +126,7 @@ $ sudo apt-get install rdoc
 
 When rendering markdown, yard will use one of several possible markdown providers,
 [in order of priority](https://github.com/lsegal/yard/blob/e833aac7a01510245dd4ae1d1d18b046c8293c2d/lib/yard/templates/helpers/markup_helper.rb#L26-L33).
-If you are experiencing rendering bugs (#1410, #1543), try adding one of the
+If you are experiencing rendering bugs (example [1](https://github.com/lsegal/yard/issues/1410) [2](https://github.com/lsegal/yard/issues/1543)), try adding one of the
 gems further up in the list to your Gemfile.
 
 ## Usage