docs: add known limitation for comments #21

Author: metonym

README.md

@@ -145,6 +145,19 @@ interface CreateConfigOptions {
 }
 ```
 
+## Limitations
+
+### Comments in script blocks
+
+Single line comments in Svelte script blocks are not supported.
+
+Use multi-line comments instead.
+
+```diff
+- let toggled; // comment
++ let toggled; /** comment */
+```
+
 ## Prior art
 
 This project is inspired by [MDsveX](https://github.com/pngwn/mdsvex).

test/README.md

@@ -69,14 +69,32 @@ Second script block:
 ```svelte
 <script>
   import Button from "my-svelte-component";
+
+   
+  let toggled; /** comment */
 </script>
 
 <Button
+  bind:toggled
   attribute="value"
   on:click={() => {
     console.log("hello world");
   }}
->Print 'hello world'</Button>
+>Print 'hello world'</Button
+>
+
+{toggled}
+
+```
+
+```svelte no-eval
+<script>
+  import { onMount } from "svelte";
+
+  onMount(() => {
+    document.title = 'title';
+  });
+</script>
 
 ```
 

test/src/Button.svelte

@@ -1 +1,5 @@
-<button type="button" on:click><slot /></button>
+<script>
+  export let toggled = false;
+</script>
+
+<button type="button" on:click on:click={() => (toggled = !toggled)}><slot /></button>