diff --git a/README.md b/README.md index 75db9804a..6a02ee373 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,8 @@
-- -
- -- - - +
+
--- @@ -27,6 +21,12 @@ --- ++ + + +
+ ## 🎩 Features - 🧘 **Zero config and easy.** Don't worry about complex configurations steps. @@ -36,6 +36,10 @@ - 🎛 **Pluggable.** With plugins, you can manipulate a lot of things through the docz flow and data. - 🔐 **Typescript Support.** We have a full support for your type definitions. +## 🚧 Warning! + +> Due to performance issues docz uses Babel@7 and Webpack@4. So, if you're using some older version of this packages you'll probably get some errors! If you need to use Babel@6 you can try [docz-plugin-babel6](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-babel6), but about Webpack@4 we can't do anything! + ## 🤔 Why? The open source world with tools that make developers life easier and the creation of styleguides and design systems are growing and evolving so fast. New and impressive things are arising every day. Tools that allow us to evolve together are really necessary nowadays. We can't create barriers or lose time with tasks that should be trivial for us. @@ -58,10 +62,23 @@ To break barriers and facilitate the creation of tools was the purpose that Docz - [Themes](http://www.docz.site/themes) - [Plugins](http://www.docz.site/plugins) -## 🚧 Tips, tricks and warnings +## 🗃 Examples + +| name | description | +| -------------------------------------------- | -------------------------------------------- | +| [basic](https://github.com/pedronauck/docz/tree/master/examples/basic) | Some basic example | +| [using typescript](https://github.com/pedronauck/docz/tree/master/examples/typescript) | Using docz with Typescript | +| [using flow](https://github.com/pedronauck/docz/tree/master/examples/flow) | Using docz with Flow | +| [using babel@6](https://github.com/pedronauck/docz/tree/master/examples/babel6) | Using docz with Babel@6 | +| [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 postcss](https://github.com/pedronauck/docz/tree/master/examples/postcss) | Using docz parsing css with PostCSS | +| [with stylus](https://github.com/pedronauck/docz/tree/master/examples/stylus) | Using docz parsing css with Stylus | + +## 🎛 Plugins -- [Use with Babel@6](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-babel6) -- [Use PostCSS, Sass, Less or Stylus on Docz](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-css) + - **[docz-plugin-babel6](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-babel6):** Use this plugin to use older babel version +- **[docz-plugin-css](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-css):** Plugin to parse css files inside your documents ## 📟 Install and Usage