aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/.docs/content/1.introduction/1.getting-started.md
blob: 4c08c14cf00148844a568ea161ca69d170b95c23 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Getting Started

From your Markdown files to a deployed website in few minutes.

## Play online

You can start playing with Docus in your browser using Stackblitz:

:button-link[Play on StackBlitz]{size="small" icon="IconStackBlitz" href="https://stackblitz.com/github/nuxt-themes/docus-starter" blank}

## Create a new project

1. Start a fresh Docus project with:

```bash [npx]
npx nuxi@latest init docs -t themes/docus
```

2. Install the dependencies in the `docs` folder:

::code-group

  ```bash [npm]
  npm install
  ```

  ```bash [yarn]
  yarn install
  ```

  ```bash [pnpm]
  pnpm install --shamefully-hoist
  ```

::

3. Run the `dev` command to start Docus in development mode:

::code-group

```bash [npm]
npm run dev
```

```bash [yarn]
yarn dev
```

```bash [pnpm]
pnpm run dev
```

::

::alert{type="success"}
✨ Well done! A browser window should automatically open for <http://localhost:3000>
::