-
Notifications
You must be signed in to change notification settings - Fork 4
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 preview of components to documentation website #175
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is God’s work @frankieroberto! Thanks for taking it on. Left a few initial comments, will wait until these and the other todo items are done before taking a closer look.
P.S. Guess we’re gunna need a homepage illustration, huh? 😊
docs/package.json
Outdated
@@ -0,0 +1,30 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need a separate package.json
for the docs? On the other projects we add dev dependencies and scripts for building/previewing the docs to the package.json
in the root. Probably simpler.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed, the current GitHub Actions workflow will look for a npm run build
in that package to deploy the site to GitHub pages.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was assuming we’d have a separate package.json
and update the build script. I think they need to be separate as a package can’t depend on itself?
As to resizing |
@paulrobertlloyd thanks for the first look. I've addressed most of the comments, but still need to figure out why the autocomplete isn't working (any ideas?) and how to get |
f92a74b
to
82f1856
Compare
This lets you see what each component looks like, as well as the code to generate it.
Co-authored-by: Paul Robert Lloyd <[email protected]>
Co-authored-by: Paul Robert Lloyd <[email protected]>
3eab317
to
3734c10
Compare
3734c10
to
12a7d1e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done with my fiddling, and got it working with one package.json
and so similar set up to its sister project repos.
Feel free to squash and merge!
This lets you see what each component looks like, as well as the code to generate it. --------- Co-authored-by: Paul Robert Lloyd <[email protected]>
This lets you see what each component looks like, as well as the code to generate it, in a similar way to the GOV.UK Design System website and GOV.UK Component for Ruby on Rails website.
Screenshots
Before
After