docs: installation docs for Svelte

LuisEGR commented 3 months ago

I just tried to use this library after having many issues with Storybook + Svelte, but I wasn't able to have it running successfully even with an empty svelte project and following the current installation docs. So what I did was look for this repo examples and I see that those examples don't follow the docs (creating a histoire.config.js) but instead update the vite.config.js to include the histoire-svelte plugin, after I did this in my project everything works!.

I don't know if this is an old documentation or something else, but I thing the installation should work on first try so the new users don't get frustrated since they're incorrect.

Description

Additional context

What is the purpose of this pull request?

[ ] Bug fix
[ ] New Feature
[x] Documentation update
[ ] Other

Before submitting the PR, please make sure you do the following

[ ] If it's a new feature, provide a convincing reason to add it. Ideally, you should open a suggestion issue first and have it approved before working on it.
[x] Read the Contributing Guidelines.
[x] Read the Pull Request Guidelines and follow the Commit Convention.
[x] Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
[x] Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
[ ] Ideally, include relevant tests that fail without this PR but pass with it.

stackblitz[bot] commented 3 months ago

Run & review this pull request in StackBlitz Codeflow.

codesandbox[bot] commented 3 months ago

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders
Open Preview

netlify[bot] commented 3 months ago

Deploy Preview for histoire-examples-vue3 ready!

Name	Link
Latest commit	132cedcb3ccfab7367b1c8ff32fde05c39843322
Latest deploy log	https://app.netlify.com/sites/histoire-examples-vue3/deploys/65d77d0a3a041a00081091c1
Deploy Preview	https://deploy-preview-689--histoire-examples-vue3.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 3 months ago

Deploy Preview for histoire-site ready!

Name	Link
Latest commit	132cedcb3ccfab7367b1c8ff32fde05c39843322
Latest deploy log	https://app.netlify.com/sites/histoire-site/deploys/65d77d0a99f85000089eb880
Deploy Preview	https://deploy-preview-689--histoire-site.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 3 months ago

Deploy Preview for histoire-controls ready!

Name	Link
Latest commit	132cedcb3ccfab7367b1c8ff32fde05c39843322
Latest deploy log	https://app.netlify.com/sites/histoire-controls/deploys/65d77d0a9a51c000077fc071
Deploy Preview	https://deploy-preview-689--histoire-controls.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] commented 3 months ago

Deploy Preview for histoire-examples-svelte3 ready!

Name	Link
Latest commit	132cedcb3ccfab7367b1c8ff32fde05c39843322
Latest deploy log	https://app.netlify.com/sites/histoire-examples-svelte3/deploys/65d77d0a13bd590008dafdd1
Deploy Preview	https://deploy-preview-689--histoire-examples-svelte3.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Akryum commented 2 months ago

Both are equivalent and should work.

Akryum commented 2 months ago

https://stackblitz.com/edit/histoire-svelte3-starter?file=histoire.config.ts

Akryum commented 2 months ago

If you have issues, please open an Issue with a runnable minimal reproduction, thanks!

histoire-dev / histoire