docs: add build and deploy

Author: rakannimer

README.md

@@ -5,7 +5,7 @@
 <p align="center">
   <a href="https://www.npmjs.com/package/docz" target="_blank">
     <img src="https://badgen.net/npm/v/docz" alt="">
-  </>
+  </a>
   <a href="LICENSE.md" target="_blank">
     <img src="https://badgen.net/badge/license/MIT/blue" alt="">
   </a>
@@ -25,19 +25,27 @@ Create MDX files showcasing your code and Docz turns them into a live-reloading,
 
 ## Table of Contents
 
-- [📟 &nbsp; Start a New Project](#--start-a-new-project)
-- [➕ &nbsp; Add Docz to an Existing Project](#--add-docz-to-an-existing-project)
-- [🎩 &nbsp; Features](#--features)
-- [🤔 &nbsp; Why?](#--why)
-- [🗃 &nbsp; Examples](#--examples)
-- [👉🏻 &nbsp; More info on our website](#--more-info-on-our-website)
-- [🎛 &nbsp; Plugins](#--plugins)
-- [🌍 &nbsp; Around the world](#--around-the-world)
-- [💪🏻 &nbsp; Contributors](#--contributors)
-- [🤝 &nbsp; Contributing](#--contributing)
-- [💭 &nbsp; Need Help?](#--need-help)
 
-## 📟 &nbsp; Start a New Project
+- [Why ?](#why)
+- [Start a New Project](#start-a-new-project)
+- [Add Docz to an Existing Project](#add-docz-to-an-existing-project)
+- [Build](#build)
+- [Deploy](#deploy)
+- [Examples](#examples)
+- [More info on docz.site](#more-info-on-doczsite)
+- [Used by](#used-by)
+- [Contributors](#contributors)
+- [Contributing](#contributing)
+
+## Why ?
+
+Documenting code is one of the most important and time-heavy processes when developing software.
+
+A lot of time is spent on building and maintaining custom documentation sites. 
+
+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/).
+
+## Start a New Project
 
 Use [create-docz-app](https://www.npmjs.com/package/create-docz-app) to quickly get started :
 
@@ -47,16 +55,16 @@ npx create-docz-app my-docz-app
 yarn create docz-app my-docz-app --example typescript
 ```
 
-## ➕ &nbsp; Add Docz to an Existing Project
+## Add Docz to an Existing Project
 
 Start by adding `docz` as a dependency :
 
 ```bash
-$ yarn add --dev docz@next # react react-dom
+$ yarn add docz@next # react react-dom
 
 # or
 
-$ npm install --save-dev docz@next # react react-dom
+$ npm install docz@next # react react-dom
 ```
 
 > **Note**: `react` and `react-dom` will not be installed automatically. You'll have to install them yourself.
@@ -94,7 +102,7 @@ const Button = ({ children, type }) => <button type={type}>{children}</button>
 
 Button.propTypes = {
   /**
-   * This is a pretty good description for this prop.
+   * This is a description for this prop.
    * Button type.
    */
   type: t.oneOf(['button', 'submit', 'reset']),
@@ -105,58 +113,48 @@ Button.defaultProps = {
 export default Button
 ```
 
-Finally, run the Docz development server:
+Finally, run:
 
 ```bash
-$ yarn docz dev
+yarn docz dev
 ```
 
-That's it! You now have an interactive site to showcase and debug your components, and some badass documentation as a nice bonus 👊
+This will start a local development server and open your documentation site in the browser.
 
-## 🎩 &nbsp; Features
+## Build 
 
-- 🔩 **Powered by Gatsby.** Bundling and ecosystem powered by [Gatsby](https://gatsbyjs.org).
-- 🧘 **Zero config and easy.** Don't worry about complex configurations steps.
-- ⚡️ **Blazing Fast.** Hot reload support and automatic code splitting out of the box.
-- 💅 **Easy to customize.** Create and use real customizable themes.
-- 📝 **[MDX](https://github.com/mdx-js/mdx) Based.** Write markdown enhanced by the power of components.
-- 🎛 **Pluggable.** Use plugins to manipulate and customize Docz to suit your needs.
-- 🔐 **Typescript Support.** Full support for TypeScript. Write your type definitions with no extra setup required.
+`yarn docz build` will generate a static site for your site in `.docz/dist/`.
 
-Still not convinced? Check [our docs](http://docz.site) to learn more about **Docz**!
+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`). 
 
-## 🤔 &nbsp; Why?
+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`. 
 
-Libraries that make development easier are appearing every day. Style guides and design systems are growing in popularity. Today, tools that allow us to get our best work done and be efficient are necessary. We shouldn't be spending too much time on tasks that should be trivial. This is why we created **Docz**.
+## Deploy
 
-Documenting code is one of the most important and time-heavy processes when you're creating something new. A lot of time is wasted on unnecessarily attempting to build a documentation site that will match the style you want.
+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. 
 
-## 🗃 &nbsp; Examples
+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.
 
-- **[basic](https://github.com/pedronauck/docz/tree/master/examples/basic)** - Barebones example.
-- **[gatsby](https://github.com/pedronauck/docz/tree/master/examples/gatsby)** - Example using Docz in a Gastby project.
-- **[react native](https://github.com/pedronauck/docz/tree/master/examples/react-native)** - Using Docz in a React Native project.
-- **[styled-components](https://github.com/pedronauck/docz/tree/master/examples/styled-components)** - Using Docz with `styled-components`.
-- **[with typescript](https://github.com/pedronauck/docz/tree/master/examples/typescript)** - Using Docz with Typescript.
-- **[with flow](https://github.com/pedronauck/docz/tree/master/examples/flow)** - Using Docz with Flow.
-- **[with images](https://github.com/pedronauck/docz/tree/master/examples/images)** - Using Docz with images in mdx and jsx.
-- **[with custom themes](https://github.com/pedronauck/docz/tree/master/examples/with-themes-dir)** - Using Docz with a custom themes directory.
+## Examples
 
-- **[with sass](https://github.com/pedronauck/docz/tree/master/examples/sass)** - Using Docz parsing CSS with SASS.
-- **[with less](https://github.com/pedronauck/docz/tree/master/examples/less)** - Using Docz parsing CSS with LESS.
-- **[with stylus](https://github.com/pedronauck/docz/tree/master/examples/css-stylus)** - Using Docz parsing CSS with Stylus.
-- **with css modules**: works out of the box with gatsby
+- **[basic](https://github.com/doczjs/docz/tree/master/examples/basic)** - Barebones example.
+- **[gatsby](https://github.com/doczjs/docz/tree/master/examples/gatsby)** - Example using Docz in a Gastby project.
+- **[react native](https://github.com/doczjs/docz/tree/master/examples/react-native)** - Using Docz in a React Native project.
+- **[styled-components](https://github.com/doczjs/docz/tree/master/examples/styled-components)** - Using Docz with `styled-components`.
+- **[with typescript](https://github.com/doczjs/docz/tree/master/examples/typescript)** - Using Docz with Typescript.
+- **[with flow](https://github.com/doczjs/docz/tree/master/examples/flow)** - Using Docz with Flow.
+- **[with images](https://github.com/doczjs/docz/tree/master/examples/images)** - Using Docz with images in mdx and jsx.
 
-## 👉🏻 &nbsp; More info on [our website](https://docz.site)
+- **[with sass](https://github.com/doczjs/docz/tree/master/examples/sass)** - Using Docz parsing CSS with SASS.
+- **[with less](https://github.com/doczjs/docz/tree/master/examples/less)** - Using Docz parsing CSS with LESS.
+- **[with stylus](https://github.com/doczjs/docz/tree/master/examples/css-stylus)** - Using Docz parsing CSS with Stylus.
+- **with css modules**: works out of the box with gatsby
 
-## 🎛 &nbsp; Plugins
+You can check the complete list of docz examples [here](https://github.com/doczjs/docz/tree/master/examples).
 
-- **[gatsby-theme-docz](https://github.com/pedronauck/docz/tree/master/core/gatsby-theme-docz)** - Use Docz as a theme for Gatsby.
-- **[netlify](https://github.com/nicholasess/docz-plugin-netlify)** - Deploy your Docz site to [Netlify](http://netlify.com/).
-- **[svg sprite loader](https://github.com/trustedhousesitters/docz-plugin-svg-sprite-loader)** - Docz plugin for SVG sprite loader.
-- **[snapshots](https://github.com/JosephConradBlack/docz-plugin-snapshots)** - A plugin for Docz that creates jest snapshots for all documented component usages.
+## More info on [docz.site](https://docz.site)
 
-## 🌍 &nbsp; Around the world
+## Used by
 
 - **[Smooth UI](https://smooth-ui.smooth-code.com/)** - Modern React UI library.
 - **[Set Protocol Docs](https://docs.setprotocol.com/)** - Documentation site of Set Protocol.
@@ -167,25 +165,25 @@ Documenting code is one of the most important and time-heavy processes when you'
 - **[React Hotkey Tooltip](https://react-hotkey-tooltip.netlify.com/#/)** - A global Hotkey provider with built in tooltip for React.
 - **[Sajari React SDK](https://sajari-sdk-react.netlify.com/)** - Library of React Components for the Sajari.
 
-## 💪🏻 &nbsp; Contributors
+## Contributors
 
 This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
 
-<a href="https://github.com/pedronauck/docz/graphs/contributors"><img src="https://opencollective.com/docz/contributors.svg?width=890&button=false" /></a>
+<a href="https://github.com/doczjs/docz/graphs/contributors"><img src="https://opencollective.com/docz/contributors.svg?width=890&button=false" /></a>
 
-## 🤝 &nbsp; Contributing
+## Contributing
 
 All kinds of contributions are very welcome and appreciated !
 
-If you want to contribute time to docz then here's a list to get you started :
+If you want to contribute time to docz then here's a list of suggestions to get you started :
 
-1. ⭐️ Star the project
-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
-3. 🐛 Find and report issues
-4. 📥 Submit PRs to help solve issues or add features
-5. ✋ Influence the future of docz with feature requests
+1. Star the project.
+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.
+3. Find and report issues.
+4. Submit PRs to help solve issues or add features.
+5. Influence the future of docz with feature requests.
 
-If you're looking for a place to start make sure to check issues tagged with
+If you're looking for a place to start make sure to check issues tagged with :
 
 [![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)
 
@@ -197,11 +195,4 @@ You can also contribute money to help secure docz's future.
   <a href="https://opencollective.com/docz" target="_blank">
     <img src="https://cdn-std.dprcdn.net/files/acc_649651/Q5nVhT" height="80" alt="Open Collective">
   </a>
-  <a href="https://www.patreon.com/pedronauck" target="_blank">
-    <img src="https://cdn-std.dprcdn.net/files/acc_649651/plrSCT" height="80" alt="Patreon">
-  </a>
-</p>
-
-## 💭 &nbsp; Need Help?
-
-If you need some help, feel free to open an issue with a description of the problem you're facing or chat with us on [our Spectrum Community](https://spectrum.chat/docz).
+</p>