feat: adjust examples and previews (#50)

fedimint · Sep 30, 2024 · 3b343fa · 3b343fa
1 parent 26918da
commit 3b343fa
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 14 deletions.
diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts
@@ -61,6 +61,10 @@ const FedimintWalletSidebar = [
         text: 'isOpen()',
         link: 'isOpen',
       },
+      {
+        text: 'open()',
+        link: 'open',
+      },
       {
         text: 'cleanup()',
         link: 'cleanup',

diff --git a/docs/core/FedimintWallet/isOpen.md b/docs/core/FedimintWallet/isOpen.md
@@ -0,0 +1,5 @@
+This guide hasn't been written yet.
+
+If you'd like to contribute, please open a PR!
+
+You can use the `Edit This Page` link below.
diff --git a/docs/core/getting-started.md b/docs/core/getting-started.md
@@ -187,7 +187,9 @@ await wallet.lightning.payBolt11Invoice('lnbc...')
 
 ## Examples
 
-Check out the Vite + React example in the [`examples/vite-core`](https://github.com/fedimint/fedimint-web-sdk/tree/main/examples/vite-core) directory. You can also view a live demo [here](https://fedimint.github.io/fedimint-web-sdk/).
+Check out an example app using [Vite + React example](../examples/vite-react.md).
+
+Check out an example app using [VanillaJS + HTML](../examples/bare-js.md).
 
 ## Resources
 

diff --git a/docs/examples/bare-js.md b/docs/examples/bare-js.md
@@ -16,7 +16,7 @@ There's no ui, so open your browser's console to see the library in action.
 You might need to disable your adblocker or Brave Shields to see the preview.
 :::
 
-<iframe src="https://stackblitz.com/github/fedimint/fedimint-web-sdk/tree/main/examples/bare-js?embed=1" style=" width: 100%; height: 600px; border: 0;"></iframe>
+<iframe src="https://stackblitz.com/github/fedimint/fedimint-web-sdk/tree/main/examples/bare-js?embed=1&file=index.html" style=" width: 100%; height: 600px; border: 0;"></iframe>
 
 [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/fedimint/fedimint-web-sdk/tree/main/examples/bare-js)
 

diff --git a/docs/examples/vite-react.md b/docs/examples/vite-react.md
@@ -10,8 +10,11 @@ This is an example application demonstrating the usage of Fedimint client in Rea
 
 ## Live Preview
 
-<iframe src="https://stackblitz.com/github/fedimint/fedimint-web-sdk/tree/main/examples/vite-core?embed=1" style="width: 100%; height: 600px; border: 0;"></iframe>
+::: tip
+You might need to disable your adblocker or Brave Shields to see the preview.
+:::
 
+<iframe src="https://stackblitz.com/github/fedimint/fedimint-web-sdk/tree/main/examples/vite-core?embed=1&file=src%2FApp.tsx" style="width: 100%; height: 600px; border: 0;"></iframe>
 [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/fedimint/fedimint-web-sdk/tree/main/examples/vite-core)
 
 ## Running the Example Locally

diff --git a/examples/vite-core/tsconfig.json b/examples/vite-core/tsconfig.json
@@ -16,6 +16,5 @@
     "noEmit": true,
     "jsx": "react-jsx"
   },
-  "include": ["src"],
-  "references": [{ "path": "./tsconfig.node.json" }]
+  "include": ["src"]
 }
diff --git a/examples/vite-core/tsconfig.node.json b/examples/vite-core/tsconfig.node.json