We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
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)
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
ruby -v
yard -v
Also opened same issue in rubydoc.info, but it's less active there.
The text was updated successfully, but these errors were encountered:
No branches or pull requests
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
and the yardoc_frontpage.md
My testing gem location: https://github.com/xuan-cao-swi/sample-ruby-gem
Environment details:
ruby -v
): ruby 3.1.0p0 (2021-12-25 revision fb4df44d16) [arm64-darwin22]yard -v
): yard 0.9.36Also opened same issue in rubydoc.info, but it's less active there.
The text was updated successfully, but these errors were encountered: