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

Commit 3335deb

Browse files
committed
docs: update used by section
1 parent 2029c25 commit 3335deb

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ Create MDX files showcasing your code and Docz turns them into a live-reloading,
2525

2626
## Table of Contents
2727

28-
2928
- [Why ?](#why)
3029
- [Start a New Project](#start-a-new-project)
3130
- [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,
4140

4241
Documenting code is one of the most important and time-heavy processes when developing software.
4342

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

4645
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/).
4746

@@ -121,17 +120,17 @@ yarn docz dev
121120

122121
This will start a local development server and open your documentation site in the browser.
123122

124-
## Build
123+
## Build
125124

126125
`yarn docz build` will generate a static site for your site in `.docz/dist/`.
127126

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

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

132131
## Deploy
133132

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

136135
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.
137136

@@ -156,14 +155,15 @@ You can check the complete list of docz examples [here](https://github.com/doczj
156155

157156
## Used by
158157

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.
160+
- **[Mobx React](https://mobx-react.js.org/)** : mobx-react documentation site.
161+
- **[React Google Charts](https://react-google-charts.com/)** : A thin, typed, React wrapper over Google Charts Visualization and Charts API.
162+
- **[Entur](https://developer.entur.org/)** : Entur operates the national registry for all public transport in Norway.
163+
- **[FAB Specification](https://fab.dev/)** : 💎 FABs are a compile target for frontend applications.
164+
- **[@umijs/hooks](https://hooks.umijs.org/)**: React Hooks Library.
165+
- **[React Yandex Maps](https://react-yandex-maps.now.sh/)**: Yandex Maps API bindings for React.
166+
- **[Add your site](https://github.com/doczjs/docz/edit/master/README.md)**
167167

168168
## Contributors
169169

@@ -195,4 +195,4 @@ You can also contribute money to help secure docz's future.
195195
<a href="https://opencollective.com/docz" target="_blank">
196196
<img src="https://cdn-std.dprcdn.net/files/acc_649651/Q5nVhT" height="80" alt="Open Collective">
197197
</a>
198-
</p>
198+
</p>

0 commit comments

Comments
 (0)