You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 16, 2026. It is now read-only.
Getting started with **Docz** is something really easy and quick.
20
-
First of all, you will need to install **Docz** using your favorite package manager:
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.
21
24
22
-
```bash
23
-
$ yarn add docz@next react react-dom
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 :
30
+
31
+
```sh
32
+
yarn add docz@next # react react-dom
24
33
```
25
34
or
26
-
```bash
27
-
$ npm add docz@next react react-dom
35
+
```sh
36
+
npm add docz@next# react react-dom
28
37
```
29
38
30
-
> ### Warnings and tips
31
-
> Don't forget to install **react** and **react-dom**
39
+
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.
32
40
33
-
> After you installed Docz in your project, you may find it convenient to add two scripts in your `package.json` to run Docz for you. This is an **optional step**:
_MDX_ is markdown with extra everything. We cover more on what you can do with _MDX_ under [**Writing MDX**](/docs/writing-mdx)
95
+
We cover more of what you can do with _MDX_ in the [**Writing MDX**](/docs/writing-mdx) page.
96
+
97
+
## Build
98
+
99
+
`yarn docz build` will generate a static site for your site in `.docz/dist/`.
100
+
101
+
You can try it out with `yarn docz serve` or by serving the generated site with your favorite static file server (e.g. `npx serve .docz/dist`).
102
+
103
+
You can have `yarn docz build` emit to a different directory by providing a path to the `dest` field in your doczrc.js or from the command line : `yarn docz build --dest docs-site-directory`.
104
+
105
+
## Deploy
106
+
107
+
The output of docz consists of static assets only. This allows you to deploy your generated `docz` site with any static site hosting provider you'd like.
108
+
109
+
Start by building your site with `yarn docz build`, if you haven't provided a `dest` flag to your config then you will find your generated files in `.docz/dist` that you can copy to your server to deploy your site.
110
+
111
+
## Examples
112
+
113
+
You can check the complete list of docz examples [here](https://github.com/doczjs/docz/tree/master/examples).
114
+
115
+
116
+
## Migration Guide
117
+
118
+
This documentation is about **Docz v2**.
119
+
120
+
If you need to migrate your Docz project, please read the [**Migration Guide**](/docs/migration-guide).
121
+
122
+
If you are looking for documentation for v1 you can find it [**here**](https://docz-v1.surge.sh/).
0 commit comments