lsegal / yard

YARD is a Ruby Documentation tool. The Y stands for "Yay!"
http://yardoc.org
MIT License
1.95k stars 398 forks source link

`--readme` option fails to select markdown files other than README.md in rubydoc.info #1551

Open xuan-cao-swi opened 2 months ago

xuan-cao-swi commented 2 months ago

Not sure if this is the right place to ask, but hopefully I can get some insight from the YARD perspective and others who have had this issue.

Rubydoc.info seems always choose the README.md as the index, other than the markdown that --readme point at.

It's working on my local yard server (e.g. through yardoc; yard server)

Steps to reproduce

Here is my .yardopts

--no-private
--markup markdown
--readme yardoc_frontpage.md
lib/hola.rb
lib/hello.rb

and the yardoc_frontpage.md

# Welcome to the Hola Xuan

This is a test gem

## Headline 2

Empty

### Headline 3

Empty

My testing gem location: https://github.com/xuan-cao-swi/sample-ruby-gem

Environment details:

Also opened same issue in rubydoc.info, but it's less active there.