Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

--readme option fails to select markdown files other than README.md #192

Open
xuan-cao-swi opened this issue Aug 21, 2024 · 0 comments
Open

Comments

@xuan-cao-swi
Copy link

Rubydoc.info seems always choose the README.md as the index: https://www.rubydoc.info/gems/hola-xuan

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant