From 39cf82431f34b3ff339e26a346a04e7ca8f11069 Mon Sep 17 00:00:00 2001 From: braks <78412429+bcakmakoglu@users.noreply.github.com> Date: Sun, 5 Nov 2023 12:07:09 +0100 Subject: [PATCH] docs(guide): update intro page --- docs/src/.vitepress/config.mts | 1 + docs/src/.vitepress/windi.config.ts | 4 -- docs/src/guide/getting-started.md | 42 +++++++++--------- docs/src/guide/index.md | 68 ++++++++++++++++++++++------- 4 files changed, 74 insertions(+), 41 deletions(-) diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts index d8a6e41d..333f2ab0 100644 --- a/docs/src/.vitepress/config.mts +++ b/docs/src/.vitepress/config.mts @@ -106,6 +106,7 @@ export default defineConfigWithTheme({ }), Icons({ compiler: 'vue3', + defaultClass: 'inline-block align-middle' }), ], }, diff --git a/docs/src/.vitepress/windi.config.ts b/docs/src/.vitepress/windi.config.ts index a4325071..2e050334 100644 --- a/docs/src/.vitepress/windi.config.ts +++ b/docs/src/.vitepress/windi.config.ts @@ -21,10 +21,6 @@ export default defineConfig({ scrollbar, ], - shortcuts: { - 'primary-gradient': 'bg-gradient-to-b from-accent-500 via-accent-700 to-accent-900', - }, - theme: { extend: { colors: { diff --git a/docs/src/guide/getting-started.md b/docs/src/guide/getting-started.md index b7b3dc09..82b2e7a5 100644 --- a/docs/src/guide/getting-started.md +++ b/docs/src/guide/getting-started.md @@ -32,32 +32,35 @@ and [edges](/typedocs/types/Edge) Nodes additionally need a specific position, while edges require a source and a target, both represented by node ids. -Below is a basic example: +::: warning Attention! +To ensure Vue Flow's is correctly displayed, make sure you include the necessary styles. + +Refer to the [Theming](/guide/theming) section for additional information. +::: ```vue -