From 6f9d75916f7fb5e2c1bd1946a5dca222a65a852e Mon Sep 17 00:00:00 2001 From: Farzad Hayatbakhsh Date: Tue, 9 Jul 2024 12:04:24 +1000 Subject: [PATCH 1/3] INT-3320: Update Quick Start guide in README.md --- README.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d078153..0cfc2b2 100644 --- a/README.md +++ b/README.md @@ -10,40 +10,48 @@ This package is a thin wrapper around [TinyMCE](https://github.com/tinymce/tinym * For the TinyMCE Svelte Technical Reference, see: [TinyMCE Documentation - TinyMCE Svelte Technical Reference](https://www.tiny.cloud/docs/tinymce/7/svelte-ref/). * For our quick demos, check out the TinyMCE Svelte [Storybook](https://tinymce.github.io/tinymce-svelte/). - ## Quick start -### Create a Svelte App from a template +### Create a Svelte App with Vite -``` -npx degit sveltejs/template my-tiny-app -cd my-tiny-app +```bash +npm create vite@5 tinymce-svelte-demo -- --template svelte-ts +cd tinymce-svelte-demo +npm install ``` ### Add the Editor component -Install the editor component in your project - -``` +```bash npm install @tinymce/tinymce-svelte ``` -## Import the TinyMCE component +### Import the TinyMCE component -Import the TinyMCE component inside the script tag of your Svelte app +Replace the contents of `src/App.svelte` with the following code and replace `your-api-key` with your Tiny Cloud API key: -``` +```html
-

Hello Tiny

- +

Hello Tiny

+
- ``` +### Run the app + +```bash +npm run dev +``` ### Issues -Have you found an issue with tinymce-svelte or do you have a feature request? Open up an [issue](https://github.com/tinymce/tinymce-svelte/issues) and let us know or submit a [pull request](https://github.com/tinymce/tinymce-svelte/pulls). *Note: For issues concerning TinyMCE please visit the [TinyMCE repository](https://github.com/tinymce/tinymce).* \ No newline at end of file +Have you found an issue with tinymce-svelte or do you have a feature request? Open up an [issue](https://github.com/tinymce/tinymce-svelte/issues) and let us know or submit a [pull request](https://github.com/tinymce/tinymce-svelte/pulls). *Note: For issues concerning TinyMCE please visit the [TinyMCE repository](https://github.com/tinymce/tinymce).* From ce5db41a8ab2c41f3760ea6db0eedd54e220b79f Mon Sep 17 00:00:00 2001 From: Farzad Hayatbakhsh Date: Tue, 9 Jul 2024 12:36:35 +1000 Subject: [PATCH 2/3] INT-3320: Change Vite template from `svelte-ts` to `svelte` --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0cfc2b2..204b62e 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ This package is a thin wrapper around [TinyMCE](https://github.com/tinymce/tinym ### Create a Svelte App with Vite ```bash -npm create vite@5 tinymce-svelte-demo -- --template svelte-ts +npm create vite@5 tinymce-svelte-demo -- --template svelte cd tinymce-svelte-demo npm install ``` @@ -31,7 +31,7 @@ npm install @tinymce/tinymce-svelte Replace the contents of `src/App.svelte` with the following code and replace `your-api-key` with your Tiny Cloud API key: ```html - -
-

Hello Tiny

- -
-``` - -### Run the app - -```bash -npm run dev -``` ### Issues