Skip to content

Commit 6cf3332

Browse files
committed
docs: Fix console block syntax in installation guide
Change code blocks with CLI prompts from `text` to `console` and update highlight directive comments from // to # for correct Shiki syntax.
1 parent dc6db7a commit 6cf3332

File tree

1 file changed

+13
-13
lines changed
  • docs/docs/guides/getting-started/installation

1 file changed

+13
-13
lines changed

docs/docs/guides/getting-started/installation/index.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,19 @@ npx @vendure/create my-shop
2727
Next, choose the "Quick Start" option. This is the fastest way to get a Vendure server up and running and will handle all the configuration for you.
2828
If you have Docker Desktop installed, it will create and configure a Postgres database for you. If not, it will use SQLite.
2929

30-
```text
30+
```console
3131
┌ Let's create a Vendure App ✨
3232
3333
◆ How should we proceed?
34-
│ ● Quick Start (Get up and running in a single step) // [!code highlight]
34+
│ ● Quick Start (Get up and running in a single step) # [!code highlight]
3535
│ ○ Manual Configuration
3636
3737
```
3838

3939
Next you'll be prompted to include our official Next.js storefront starter in your project. This is optional, but recommended if you want to
4040
quickly see a working storefront connected to your Vendure server.
4141

42-
```text
42+
```console
4343
┌ Let's create a Vendure App ✨
4444
4545
◇ How should we proceed?
@@ -49,10 +49,10 @@ quickly see a working storefront connected to your Vendure server.
4949
5050
◇ Docker is running
5151
52-
◆ Would you like to include the Next.js storefront? // [!code highlight]
53-
│ ○ No // [!code highlight]
54-
│ ● Yes // [!code highlight]
55-
// [!code highlight]
52+
◆ Would you like to include the Next.js storefront? # [!code highlight]
53+
│ ○ No # [!code highlight]
54+
│ ● Yes # [!code highlight]
55+
# [!code highlight]
5656
```
5757

5858
And that's it! After a minute or two, you'll have a **fully-functional Vendure server** installed locally.
@@ -75,7 +75,7 @@ Vendure supports a number of different databases. The `@vendure/create` tool wil
7575

7676
**To quickly test out Vendure, we recommend using SQLite**, which requires no external dependencies. You can always switch to a different database later [by changing your configuration file](/developer-guide/configuration/#connecting-to-the-database).
7777

78-
```text
78+
```console
7979
┌ Let's create a Vendure App ✨
8080
8181
◇ How should we proceed?
@@ -87,7 +87,7 @@ Vendure supports a number of different databases. The `@vendure/create` tool wil
8787
│ ○ MySQL
8888
│ ○ MariaDB
8989
│ ○ Postgres
90-
│ ● SQLite // [!code highlight]
90+
│ ● SQLite # [!code highlight]
9191
9292
```
9393

@@ -110,16 +110,16 @@ The final prompt will ask whether to populate your new Vendure server with some
110110

111111
**We recommend you do so**, as it will give you a good starting point for exploring the APIs, which we will cover in the [Try the API section](/getting-started/try-the-api/), as well as providing some data to use when building your own storefront.
112112

113-
```text
113+
```console
114114
┌ Let's create a Vendure App ✨
115115
116116
◇ How should we proceed?
117117
│ Manual Configuration
118118
119-
// ...
119+
# ...
120120
121121
◆ Populate with some sample product data?
122-
│ ● yes // [!code highlight]
122+
│ ● yes # [!code highlight]
123123
│ ○ no
124124
125125
```
@@ -134,7 +134,7 @@ Next, a project scaffold will be created and dependencies installed. This may ta
134134

135135
Once complete, you'll see a message like this:
136136

137-
```text
137+
```console
138138
◇ Setup complete! ─────────────────────────────────────╮
139139
│ │
140140
│ Your new Vendure project was created! │

0 commit comments

Comments
 (0)