Open jacob-carlborg opened 2 years ago
This is not an issue with --one-file
or YARD. By default, YARD uses rdoc style markup in .rb files. If you wish to use Markdown as your markup format, you must specify it via -m markdown
, see yard doc --help
.
I disagree. As you can see on the screenshots, the behavior is different with and without --one-file
. I can post a screen recording that shows the whole flow.
Here's a screen recording that shows how I generate the documentation both with and without the --one-file
flag. I show both results in the browser side by side:
https://user-images.githubusercontent.com/306980/150955201-062274c5-c202-4571-8b2f-fe446ae973ee.mov
The
--one-file
flag does not interpret Markdown by default in theREADME.md
file (I have not checked other non-source files).Steps to reproduce
cat << EOF >> README.md
Foo
EOF
yard doc --one-file --no-save -o . foo.rb