Skip to content

Commit

Permalink
documentation about markdown providers
Browse files Browse the repository at this point in the history
closes lsegal#1410
closes lsegal#1543
  • Loading branch information
jjb committed Mar 28, 2024
1 parent e833aac commit 91040be
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Expand Up @@ -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
Expand Down

0 comments on commit 91040be

Please sign in to comment.