Skip to content
This repository was archived by the owner on Jan 24, 2025. It is now read-only.

Commit 09fea5e

Browse files
docs(docz): rewrite readme (#1656)
Co-authored-by: Renato Benkendorf <[email protected]>
1 parent 70fa4fd commit 09fea5e

File tree

1 file changed

+31
-41
lines changed

1 file changed

+31
-41
lines changed

README.md

+31-41
Original file line numberDiff line numberDiff line change
@@ -20,35 +20,24 @@ Create MDX files showcasing your code and Docz turns them into a live-reloading,
2020

2121
![docz example](https://cdn-std.dprcdn.net/files/acc_649651/S2YCID)
2222

23-
## Table of Contents
24-
25-
- [Why?](#why)
26-
- [Getting started](#getting-started)
27-
- [Build](#build)
28-
- [Deploy](#deploy)
29-
- [Examples](#examples)
30-
- [More info on docz.site](#more-info-on-doczsite)
31-
- [Used by](#used-by)
32-
- [Contributors](#contributors)
33-
- [Contributing](#contributing)
34-
3523
## Why?
3624

37-
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.
3826

3927
A lot of time is spent on building and maintaining custom documentation sites.
4028

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/).
4230

43-
## Getting started
31+
### About `create-docz-app`
4432

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
5039

51-
Start by adding `docz` as a dependency:
40+
Start by adding `docz` as a dependency to your project with Yarn or npm:
5241

5342
```bash
5443
$ yarn add docz # react react-dom
@@ -60,7 +49,7 @@ $ npm install docz # react react-dom
6049

6150
> **Note**: `react` and `react-dom` will not be installed automatically. You'll have to install them yourself.
6251
63-
Then, add `.mdx` files anywhere in your project:
52+
Then, create `.mdx` files anywhere in your project:
6453

6554
```mdx
6655
---
@@ -110,19 +99,20 @@ Finally, run:
11099
yarn docz dev
111100
```
112101

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.
114103

115104
## Build
116105

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/`.
118107

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`).
120109

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`.
122111

123-
## Deploy
112+
## Deploying
124113

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.
126116

127117
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.
128118

@@ -149,12 +139,12 @@ Start by building your site with `yarn docz build`, if you haven't provided a `d
149139

150140
## Used by
151141

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.
154-
- **[Mobx React](https://mobx-react.js.org/)** : mobx-react documentation site.
155-
- **[React Google Charts](https://react-google-charts.com/)** : A thin, typed, React wrapper over Google Charts Visualization and Charts API.
156-
- **[Entur](https://developer.entur.org/)** : Entur operates the national registry for all public transport in Norway.
157-
- **[FAB Specification](https://fab.dev/)** : 💎 FABs are a compile target for frontend applications.
142+
- **[Welcome UI](https://welcome-ui.com/)**: Customizable design system with react • styled-components • styled-system and reakit.
143+
- **[React Hooks Testing Library](https://react-hooks-testing-library.com/)**: 🐏 Simple and complete React hooks testing utilities that encourage good testing practices.
144+
- **[Mobx React](https://mobx-react.js.org/)**: mobx-react documentation site.
145+
- **[React Google Charts](https://react-google-charts.com/)**: A thin, typed, React wrapper over Google Charts Visualization and Charts API.
146+
- **[Entur](https://developer.entur.org/)**: Entur operates the national registry for all public transport in Norway.
147+
- **[FAB Specification](https://fab.dev/)**: 💎 FABs are a compile target for frontend applications.
158148
- **[@umijs/hooks](https://hooks.umijs.org/)**: React Hooks Library.
159149
- **[React Yandex Maps](https://react-yandex-maps.now.sh/)**: Yandex Maps API bindings for React.
160150
- **[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
168158

169159
## Contributing
170160

171-
All kinds of contributions are very welcome and appreciated !
161+
All kinds of contributions are very welcome and appreciated!
172162

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:
174164

175-
1. Star the project.
165+
1. Star the project on GitHub.
176166
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.
177167
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.
179169
5. Influence the future of docz with feature requests.
180170

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:
182172

183173
[![Good First Issue](https://img.shields.io/github/issues/doczjs/docz/good%20first%20issue.svg)](https://github.com/doczjs/docz/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
184174

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.
186176

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.
188178

189179
<p align="center">
190180
<a href="https://opencollective.com/docz" target="_blank">

0 commit comments

Comments
 (0)