fix: base url, links, gradient (#45)

fedimint · Sep 26, 2024 · 7ea5b6d · 7ea5b6d
1 parent 20a2783
commit 7ea5b6d
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 5 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -8,7 +8,7 @@ export default withMermaid({
   ignoreDeadLinks: false,
   lang: 'en-US',
   lastUpdated: true,
-  base: '/fedimint-web-sdk/',
+  // base: '/fedimint-web-sdk/',
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     editLink: {

diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts
@@ -7,8 +7,8 @@ export function getSidebar() {
       {
         text: 'Getting Started',
         items: [
-          { text: 'Overview', link: '/core/getting-started' },
-          { text: 'Installation', link: '/core/installation' },
+          { text: 'Overview', link: '/core/overview' },
+          { text: 'Installation', link: '/core/getting-started' },
           { text: 'Architecture', link: '/core/architecture' },
         ],
       },

diff --git a/docs/core/overview.md b/docs/core/overview.md
@@ -1,11 +1,13 @@
 # @fedimint/core-web
 
-### THIS IS A WORK IN PROGRESS AND NOT READY FOR SERIOUS USE
-
 This package provides a typescript interface for a fedimint client in the browser.
 
 It contains the wasm-pack output of the rust-based [fedimint client](https://github.com/fedimint/fedimint/tree/master/fedimint-client-wasm).
 
+::: danger Disclaimer
+This is still an unstable work in progress and should not be used for any serious applications. The api's are not settled and may change often.
+:::
+
 ## Key Features:
 
 - **WebAssembly-powered Client**: Exposes the robust, fault-tolerant fedimint-client (built in Rust) via WebAssembly. Lazy-Loads within a web worker for performance.

diff --git a/docs/index.md b/docs/index.md
@@ -45,3 +45,25 @@ features:
     title: Framework Agnostic
     details: Designed as a "core" library compatible with vanilla JavaScript, laying the groundwork for future framework-specific packages.
 ---
+
+<style>
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #bd34fe 30%, #41d1ff);
+
+  --vp-home-hero-image-background-image: linear-gradient(-45deg, rgba(189, 52, 254, 0.4) 50%, rgba(71, 202, 255, 0.4) 50%);
+  --vp-home-hero-image-filter: blur(68px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(88px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(120px);
+  }
+}
+</style>