Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

Commit 883d444

Browse files
authored
Merge pull request #122 from renatobenks/master
2 parents 1bc1f57 + 365e9f1 commit 883d444

File tree

1 file changed

+5
-18
lines changed

1 file changed

+5
-18
lines changed

src/docs/documentation/general/getting-started.mdx

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,11 @@ menu: General
77

88
# Getting Started
99

10-
<!-- > Starting from Docz v1 you need to have `react` and `react-dom` with versions `>= 16.8.0` installed as dependencies. -->
10+
First off, try take a look and check out [docz's `examples` directory](https://github.com/doczjs/docz/tree/master/examples) for the full list of supported examples.
1111

12+
Start by adding **docz** as a dependency:
1213

13-
## Start a New Project
14-
15-
Use create-docz-app to quickly get started :
16-
17-
```sh
18-
npx create-docz-app my-docz-app
19-
# or
20-
yarn create docz-app my-docz-app --example typescript
21-
```
22-
23-
Make sure to check out [docz's `examples` directory](https://github.com/doczjs/docz/tree/master/examples) for the full list of supported examples.
24-
25-
## Add Docz to an Existing Project
26-
27-
> Make sure you have `react` and `react-dom` with versions `>= 16.8.0` installed as dependencies.
28-
29-
Start by adding **Docz** as a dependency :
14+
> There's also a [create-docz-app](https://www.npmjs.com/package/create-docz-app), which you can be using to start new projects with docz even quicker, but it's totally independent from docz, therefore not officially supported. Once we strongly don't believe that it should be part of what we want to bring to the community as a project, but feel free to use it as much as you need, especially to replace `create-reract-app`, for example, to create new projects.
3015
3116
```sh
3217
yarn add docz # react react-dom
@@ -36,6 +21,8 @@ or
3621
npm install docz # react react-dom
3722
```
3823

24+
> Note: Make sure you have `react` and `react-dom` correctly installed as dependencies with versions `>= 16.8.0`.
25+
3926
After installing Docz in your project, you may find it convenient to add three scripts to your `package.json` to run, build and serve your Docz website.
4027

4128
Note that this is an **optional step** :

0 commit comments

Comments
 (0)