You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
(Follow-up because this wouldn't be addressed until after we merge in #268)
The video isn't yet available publicly, but having watched Joel Hawksley's presentation on how GitHub is using ViewComponent, he mentions a tool they built which parses YARD documentation for components and converts descriptions, parameters, examples, etc. into Markdown for use in a documentation site for their component library.
Hmm, Markdown. If only I knew of a tool that can render Markdown for a website… 🧐😂
Jokes aside, it's a really cool idea and one that I'd like to shamelessly clone as a plugin for Bridgetown. Imagine writing Ruby components in src/_components (whether our own solution, ViewComponent, or anything else really), running a single command, and boom all your components are documented with live examples. 🤯
I built something similar for "Liquid components" (currently broken unfortunately), but now that I'm moving away from promoting that functionality this would be a fantastic alternative.
The text was updated successfully, but these errors were encountered:
(Follow-up because this wouldn't be addressed until after we merge in #268)
The video isn't yet available publicly, but having watched Joel Hawksley's presentation on how GitHub is using ViewComponent, he mentions a tool they built which parses YARD documentation for components and converts descriptions, parameters, examples, etc. into Markdown for use in a documentation site for their component library.
Hmm, Markdown. If only I knew of a tool that can render Markdown for a website… 🧐😂
Jokes aside, it's a really cool idea and one that I'd like to shamelessly clone as a plugin for Bridgetown. Imagine writing Ruby components in
src/_components
(whether our own solution, ViewComponent, or anything else really), running a single command, and boom all your components are documented with live examples. 🤯I built something similar for "Liquid components" (currently broken unfortunately), but now that I'm moving away from promoting that functionality this would be a fantastic alternative.
The text was updated successfully, but these errors were encountered: