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
carbon sdk #1503
Labels
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
We use carbon of our open source project to generate images for documentation, GitHub releases or presentations. We support multiple languages and have various features we want to highlight using carbon generate images. Over time our collection of examples grows and it becomes hard to generate them manually. We want to have a single project with all example files in a specific language. Right now, we need to generate images manually (online or offline as PWA).
There are cases we want to update the generated images across documents due to API changes, errors, or minor tweaks. In this case we'd need to render all examples manually through the website. I can also see other users who don't want to send the code over wire and prefer to render locally (which they can with PWA).
Describe the solution you'd like
I'd like to have a carbon SDK that allows me generate images from projects or folders locally. I would run
npm run carbon generate myproject
. The SDK will scan the directory, and generate images usingcarbon.conf.json
in this project.Describe alternatives you've considered
I looked at https://github.com/mixn/carbon-now-cli which is a playwright automation wrapper around the website.
Additional context
The text was updated successfully, but these errors were encountered: