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.

Sign up for GitHub

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

Jump to bottom

Lackluster developer docs #1269

Open
1 of 12 tasks
markusbkk opened this issue Oct 7, 2023 · 1 comment
Open
1 of 12 tasks

Lackluster developer docs #1269

markusbkk opened this issue Oct 7, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@markusbkk
Copy link

I am interested in helping provide a fix!

Yes

Which generators are impacted?

  • All
  • Angular
  • HTML
  • Preact
  • Qwik
  • React
  • React-Native
  • Solid
  • Stencil
  • Svelte
  • Vue
  • Web components

Reproduction case

N/A

Expected Behaviour

Documentation on how to build and run things like the Mitosis CLI locally.

Actual Behaviour

The documentation merely states to run yarn start, which doesn't actually engage the CLI.

Additional Information

I'm interested in developing a generator for my Go-based component framework. Unfortunately, I'm unable to figure out how to make local changes to the CLI.

yarn start doesn't engage the CLI and yarn build produces a dist/ folder but running node dist/cli.js doesn't produce any output.
@markusbkk markusbkk added the bug Something isn't working label Oct 7, 2023
@samijaber
Copy link
Contributor

Have you read https://github.com/BuilderIO/mitosis/blob/main/developer/generators.md ? It includes a walkthrough of how to add a new generator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@samijaber @markusbkk