From fcf3078d5b8116060bdd03a21955b7cbf110f11d Mon Sep 17 00:00:00 2001 From: braks <78412429+bcakmakoglu@users.noreply.github.com> Date: Sun, 5 Nov 2023 12:25:56 +0100 Subject: [PATCH] docs(guide): cleanup --- docs/src/guide/getting-started.md | 48 +++++++++++++++++-------------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/docs/src/guide/getting-started.md b/docs/src/guide/getting-started.md index 82b2e7a5..c9e3c552 100644 --- a/docs/src/guide/getting-started.md +++ b/docs/src/guide/getting-started.md @@ -1,18 +1,18 @@ -# Getting Started with Vue Flow +# Kickstart Your Journey with Vue Flow! 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. ## Prerequisites -Before you begin, ensure you have the following installed on your machine: +Before you strap in, make sure you're equipped with: -- [Node.js v14 or above](https://nodejs.org/) +- [Node.js v16 or above](https://nodejs.org/) - [Vue 3.0 or above](https://vuejs.org/) ## Installation -Install Vue Flow using any of the following package managers: +Use your preferred package manager to install Vue Flow: ```bash npm i --save @vue-flow/core @@ -25,19 +25,23 @@ pnpm i @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). -Each element requires a unique id. -Nodes additionally need a specific position, while edges require a source and a +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. + +Nodes additionally need an [XY-position](/typedocs/interfaces/XYPosition), while edges require a source and a target, both represented by node ids. -::: warning Attention! +::: warning Pay 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. ::: +Here's a simple Vue Flow example to get you started: + ```vue @@ -68,11 +72,11 @@ const elements = ref([ ``` @@ -82,4 +86,4 @@ As Vue Flow is entirely written in TypeScript, we highly recommend utilizing Typ experience and prevention of common errors. The necessary type definitions are included with the library. -For more information, review our [TypeDocs documentation](/typedocs). +For more information, review our [TypeDocs documentation](/typedocs/).