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 Nov 21, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,6 @@ Create MDX files showcasing your code and Docz turns them into a live-reloading,
25
25
26
26
## Table of Contents
27
27
28
-
29
28
-[Why ?](#why)
30
29
-[Start a New Project](#start-a-new-project)
31
30
-[Add Docz to an Existing Project](#add-docz-to-an-existing-project)
@@ -41,7 +40,7 @@ Create MDX files showcasing your code and Docz turns them into a live-reloading,
41
40
42
41
Documenting code is one of the most important and time-heavy processes when developing software.
43
42
44
-
A lot of time is spent on building and maintaining custom documentation sites.
43
+
A lot of time is spent on building and maintaining custom documentation sites.
45
44
46
45
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/).
47
46
@@ -121,17 +120,17 @@ yarn docz dev
121
120
122
121
This will start a local development server and open your documentation site in the browser.
123
122
124
-
## Build
123
+
## Build
125
124
126
125
`yarn docz build` will generate a static site for your site in `.docz/dist/`.
127
126
128
-
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`).
127
+
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`).
129
128
130
-
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`.
129
+
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`.
131
130
132
131
## Deploy
133
132
134
-
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.
133
+
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.
135
134
136
135
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.
137
136
@@ -156,14 +155,15 @@ You can check the complete list of docz examples [here](https://github.com/doczj
156
155
157
156
## Used by
158
157
159
-
-**[Smooth UI](https://smooth-ui.smooth-code.com/)** - Modern React UI library.
160
-
-**[Set Protocol Docs](https://docs.setprotocol.com/)** - Documentation site of Set Protocol.
161
-
-**[RBX](https://dfee.github.io/rbx)** - The Comprehensive Bulma UI Framework for React.
162
-
-**[Circuit UI](https://circuit.sumup.com/#/)** - React component library for [SumUp](https://sumup.com) web apps.
163
-
-**[Fannypack](https://fannypack.style)** - A friendly & accessible React UI Kit built with [Reakit](https://reakit.io/).
164
-
-**[React Pixi](https://reactpixi.org/#/)** - React Fiber renderer for Pixi.
165
-
-**[React Hotkey Tooltip](https://react-hotkey-tooltip.netlify.com/#/)** - A global Hotkey provider with built in tooltip for React.
166
-
-**[Sajari React SDK](https://sajari-sdk-react.netlify.com/)** - Library of React Components for the Sajari.
158
+
-**[Welcome UI](http://welcome-ui.com/)** : Customizable design system with react • styled-components • styled-system and reakit.
159
+
-**[React Hooks Testing Library](https://react-hooks-testing-library.com/)** : 🐏 Simple and complete React hooks testing utilities that encourage good testing practices.
0 commit comments