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

feat: Follow-up component documentation feature #284

Closed
jaredcwhite opened this issue Apr 15, 2021 · 0 comments
Closed

feat: Follow-up component documentation feature #284

jaredcwhite opened this issue Apr 15, 2021 · 0 comments

Comments

@jaredcwhite
Copy link
Member

jaredcwhite commented Apr 15, 2021

(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.

@jaredcwhite jaredcwhite added this to the 0.22 "TBD" milestone Apr 16, 2021
@jaredcwhite jaredcwhite removed this from the 0.22 milestone Sep 24, 2021
@jaredcwhite jaredcwhite closed this as not planned Won't fix, can't repro, duplicate, stale Feb 17, 2024
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