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

Add gem install for markdown parser to README #26

Open
DanRathbun opened this issue Oct 24, 2021 · 2 comments
Open

Add gem install for markdown parser to README #26

DanRathbun opened this issue Oct 24, 2021 · 2 comments

Comments

@DanRathbun
Copy link
Contributor

Documentation Issue

Add gem install for markdown parser to README file.

I spent a week dealing with weirdness especially with regard to links in extra pages files.
It turned out that it all was caused by the default Rdoc parser being used for markdown parsing.

Neither the YARD documentation nor this templates README tells new users that they need to install one of the better markdown parsing gems. I assumed that they came with YARD or were part of a template. (Wrong!)

So it took Loran Segal (author of YARD) to track down the root of my problems and he told me it was me not having installed a better markdown parsing gem. (It seems this is one of those everyone familiar with non-embedded Ruby and Rubygems knows, so does not mention.)

I quickly installed Red Carpet and bing! all the problems disappeared.

And the doc generation seems twice as fast (or faster.)

So please do not let new users of the yard-sketchup plugin befall the same fate.

@thomthom
Copy link
Member

Yea, there's a number of these hidden knowledges when one start to poke into YARD.

Btw, SU's docs uses RDoc, except for the .md files that accompany the class/module docs. I really wish we had Markdown across the board, but it's a non-trivial task to reformat all the documentation.

@DanRathbun
Copy link
Contributor Author

Yes it's the extra files that I was having issues with. I'm working on "proofs of concepts".

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

No branches or pull requests

2 participants