-
Notifications
You must be signed in to change notification settings - Fork 0
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: interactive docs using Pitsby #61
Conversation
✅ Deploy Preview for oslmap ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
package.json
Outdated
"prepare": "husky install", | ||
"docs": "NODE_ENV=development pitsby build --watch", | ||
"docsPublish": "pitsby build" |
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.
👍
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 great, and super nice to use! A big improvement and a solid step forward.
The future cleanup section of your PR was great - I hit the same issues but totally think that's a next step to look at as opposed to doing it all here.
trying out Pitsby as a much lighter alternative to storybook that supports vanilla web components (Closes #26)
deployed here: https://deploy-preview-61--oslmap.netlify.app/#!/components/vanilla
get up & running locally:
pnpm i
to add new pitsby dependencypnpm run docs
builds the docs in watch mode & listens for changes; site is running at https://localhost:7000pnpm docsPublish
builds the docs so they can be served as a static site frompitsby/
deploying the docs:
I've updated Netlify "deploy settings" to publish the component library instead of the
index.html
sandbox (that's still around for local dev though). I additionally removed our OS API keys from Netlify, otherwise Pitsby would read them & put them in plaintext in the "template" section. These docs are a bring-your-own-API-key situation!https://app.netlify.com/sites/oslmap/settings/deploys
before:
after:
future cleanup: