sandbox previews in docs in my local is not working.
As the title says , i want to check for changes in the code sandbox previews of the docs. but when running docs locally , none of the previews work. what is the solution here ??
3 Replies
Hi @Srikanth. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave:
----------------------
Refine uses Codesandbox's Sandpack (https://sandpack.codesandbox.io) to provide live previews and code editors in the documentation. If you're running the documentation locally and the previews are not working, it might be due to some configuration issues.
To run the documentation locally, you need to install the dependencies and start the documentation separately. Here are the commands you need to run in your terminal:
If you want to start the documentation with all the features, you can use
npm run dev
command. To create a production build of the documentation, you can use npm run build
command. Then, you can use npm run serve
command to serve the production build in your local machine.
If the issue persists, it might be related to the custom <Sandpack />
component used in the documentation. You can check out the example usage of <Sandpack />
in Core API's useForm
hook documentation:
- useForm Documentation (https://refine.dev/docs/data/hooks/use-form/#usage)
- Source Code for Sandpack (https://github.com/refinedev/refine/blob/master/documentation/docs/core/hooks/use-form/basic-usage.tsx)
- Source Code for Markdown (https://github.com/refinedev/refine/blob/master/documentation/docs/core/hooks/use-form/index.md)
If you're still having trouble, it might be best to raise an issue on the Refine GitHub repository (https://github.com/refinedev/refine/issues) for further assistance.
Source (https://refine.dev/docs/guides-concepts/contributing#working-on-documentation)
----------------------
Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:
----------------------<@608926325402763265> kapa.ai is still learning and improving, please let us know how it did by reacting below
foreign-sapphire•5mo ago
okay i am able to run up the docs correctly , and everything works correctly , only thing the codesandbox previews are not working. and links you provided the 2nd and 3rd link are broken