diff --git a/docs/src/guide/getting-started.md b/docs/src/guide/getting-started.md index d0a80f49..08a7a61a 100644 --- a/docs/src/guide/getting-started.md +++ b/docs/src/guide/getting-started.md @@ -7,10 +7,10 @@ import LogosJavascript from '~icons/logos/javascript'; import LogosTypescript from '~icons/logos/typescript-icon'; -# Kickstart Your Journey with Vue Flow! +# Getting Started -This guide covers the basics of setting up and using Vue Flow. You'll learn how to install Vue Flow, configure it, and -utilize it within your own projects. +This guide covers the basics of setting up and using Vue Flow. +You'll learn how to install Vue Flow, configure it, and create your first flowchart. ## Prerequisites @@ -45,78 +45,110 @@ $ yarn add @vue-flow/core ## Usage -In Vue Flow, an application structure consists of [**nodes**](/typedocs/interfaces/Node) -and [**edges**](/typedocs/types/Edge), all of which are categorised as [**elements**](/typedocs/types/Elements). +In Vue Flow, a graph consists of [**nodes**](/typedocs/interfaces/Node)and [**edges**](/typedocs/types/Edge), all of which are categorised as [**elements**](/typedocs/types/Elements). -**Each element requires a unique id.** +**Each node and edge requires a unique id.** -Nodes additionally need an [XY-position](/typedocs/interfaces/XYPosition), while edges require a source and a -target, both represented by node ids. +Nodes also need an [XY-position](/typedocs/interfaces/XYPosition), while edges require a `source` and a +`target`, both represented by node ids. ::: warning NOTE! To ensure Vue Flow's is correctly displayed, make sure you include the necessary styles. +```css +/* these are necessary styles for vue flow */ +@import '@vue-flow/core/dist/style.css'; + +/* this contains the default theme, these are optional styles */ +@import '@vue-flow/core/dist/theme-default.css'; +``` + Refer to the [Theming](/guide/theming) section for additional information. ::: -Here's a simple Vue Flow example to get you started: +Here's a simple example to get you started: ::: code-group ```vue []