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 Jan 24, 2025. It is now read-only.
Documenting code is one of the most important and time-heavy processes when developing software.
25
+
Documenting code is one of the most important and time-consuming tasks when developing software.
38
26
39
27
A lot of time is spent on building and maintaining custom documentation sites.
40
28
41
-
Docz enables you to quickly create live-reloading, seo-friendly, production-ready documentation sites with MDX and customize the look, feel and behavior when required by leveraging [GatsbyJS](https://www.gatsbyjs.org) and [Gatsby theme shadowing](https://www.gatsbyjs.org/docs/themes/shadowing/).
29
+
Docz enables you to quickly create a live-reloading, SEO-friendly, production-ready documentation site with MDX and customize the look, feel and behavior when required by leveraging [GatsbyJS](https://www.gatsbyjs.org) and [Gatsby theme shadowing](https://www.gatsbyjs.org/docs/themes/shadowing/).
42
30
43
-
##Getting started
31
+
### About `create-docz-app`
44
32
45
-
> There's also a [create-docz-app](https://www.npmjs.com/package/create-docz-app),
46
-
> which you can be using to start new projects with docz even quicker,
47
-
> but it's totally independent from docz, therefore not officially supported.
48
-
> Once we strongly don't believe that it should be part of what we want to bring to the community as a project,
49
-
> but feel free to use it as much as you need, especially to replace `create-react-app`, for example, to create new projects.
33
+
There's a [create-docz-app](https://www.npmjs.com/package/create-docz-app), which you can use to start new projects with docz even faster.
34
+
This app is developed independently of the docz project, and is not officially supported.
35
+
So use the app at your own risk.
36
+
You can use `create-docz-app` as a replacement for `create-react-app`, when you're creating a new project.
37
+
38
+
## Getting started
50
39
51
-
Start by adding `docz` as a dependency:
40
+
Start by adding `docz` as a dependency to your project with Yarn or npm:
> **Note**: `react` and `react-dom` will not be installed automatically. You'll have to install them yourself.
62
51
63
-
Then, add`.mdx` files anywhere in your project:
52
+
Then, create`.mdx` files anywhere in your project:
64
53
65
54
```mdx
66
55
---
@@ -110,19 +99,20 @@ Finally, run:
110
99
yarn docz dev
111
100
```
112
101
113
-
This will start a local development server and open your documentation site in the browser.
102
+
This starts a local development server and opens your documentation site in the browser.
114
103
115
104
## Build
116
105
117
-
`yarn docz build`will generate a static site for your site in `.docz/dist/`.
106
+
`yarn docz build`generates a static site in `.docz/dist/`.
118
107
119
-
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`).
108
+
Try it with `yarn docz serve` or by serving the generated site with your favorite static file server (e.g. `npx serve .docz/dist`).
120
109
121
-
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`.
110
+
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`.
122
111
123
-
## Deploy
112
+
## Deploying
124
113
125
-
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.
114
+
The output of docz consists of static assets only.
115
+
This allows you to deploy your generated `docz` site with any static site hosting provider you'd like.
126
116
127
117
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` to copy to the server.
128
118
@@ -149,12 +139,12 @@ Start by building your site with `yarn docz build`, if you haven't provided a `d
149
139
150
140
## Used by
151
141
152
-
-**[Welcome UI](https://welcome-ui.com/)**: Customizable design system with react • styled-components • styled-system and reakit.
153
-
-**[React Hooks Testing Library](https://react-hooks-testing-library.com/)**: 🐏 Simple and complete React hooks testing utilities that encourage good testing practices.
-**[React Yandex Maps](https://react-yandex-maps.now.sh/)**: Yandex Maps API bindings for React.
160
150
-**[Components-extra](https://components-extra.netlify.com)**: Customizable react component blocks built with material-ui and styled-components.
@@ -168,23 +158,23 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
168
158
169
159
## Contributing
170
160
171
-
All kinds of contributions are very welcome and appreciated!
161
+
All kinds of contributions are very welcome and appreciated!
172
162
173
-
If you want to contribute time to docz then here's a list of suggestions to get you started:
163
+
If you want to contribute time to docz then here's a list of suggestions to get you started:
174
164
175
-
1. Star the project.
165
+
1. Star the project on GitHub.
176
166
2. Help people in the [issues](https://github.com/doczjs/docz/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) by sharing your knowledge and experience.
177
167
3. Find and report issues.
178
-
4. Submit PRs to help solve issues or add features.
168
+
4. Submit pull requests to help solve issues or add features.
179
169
5. Influence the future of docz with feature requests.
180
170
181
-
If you're looking for a place to start make sure to check issues tagged with :
171
+
If you're looking for a place to start make sure to check issues tagged with the `good first issue` label:
182
172
183
173
[](https://github.com/doczjs/docz/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
184
174
185
-
And make sure to read the [Contributing Guide](/CONTRIBUTING.md) before making a pull request.
175
+
Read the [Contributing Guide](/CONTRIBUTING.md) before you open a pull request.
186
176
187
-
You can also contribute money to help secure docz's future.
177
+
You can also sponsor us via OpenCollective to help secure docz's future.
0 commit comments