Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: integration with react native 🌉 #271

Merged
merged 14 commits into from
Sep 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,15 @@ Documenting our things is one of the most important and heavy processes when you
## 🎛   Plugins

- **[css](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-css)** - Parse css files inside your documents
- **[babel6](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-babel6)** - Use this plugin to use older babel version
- **[babel6](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-babel6)** - Use this plugin to use older babel version **[DEPRECATED]** ⚠️
- **[react-native](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-svgr)** - Allow you to use docz with React Native
- **[svgr](https://github.com/pedronauck/docz/blob/master/packages/docz-plugin-svgr)** - Allow you to parse svg using svgr

## 🗃   Examples

- **[basic](https://github.com/pedronauck/docz/tree/master/examples/basic)** - Some basic example
- **[react-native-flow](https://github.com/pedronauck/docz/tree/master/examples/react-native-flow)** - Using in a React Native project with flow
- **[react-native-prop-types](https://github.com/pedronauck/docz/tree/master/examples/react-native-prop-types)** - Using in a React Native project with propTypes
- **[babel 6](https://github.com/pedronauck/docz/tree/master/examples/babel6)** - Using docz with Babel@6 ***(DEPRECATED)️***
- **[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
Expand All @@ -95,6 +98,7 @@ Documenting our things is one of the most important and heavy processes when you
- **[with postcss](https://github.com/pedronauck/docz/tree/master/examples/css-postcss)** - Using docz parsing css with PostCSS
- **[with stylus](https://github.com/pedronauck/docz/tree/master/examples/css-stylus)** - Using docz parsing css with Stylus


## 🚧   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! About webpack 4 we can't do anything, but about babel, we indicate that you update your babel version. You can do that just by running [babel-upgrade](https://github.com/babel/babel-upgrade):
Expand Down
2 changes: 1 addition & 1 deletion examples/flow/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
"build": "docz build"
},
"dependencies": {
"@babel/preset-flow": "^7.0.0",
"emotion": "^9.2.8",
"prop-types": "^15.6.2",
"react": "^16.4.2",
"react-dom": "^16.4.2",
"react-emotion": "^9.2.8"
},
"devDependencies": {
"@babel/preset-flow": "^7.0.0",
"docz": "^0.10.3",
"babel-plugin-emotion": "^9.2.8",
"flow-bin": "^0.79.1",
Expand Down
5 changes: 5 additions & 0 deletions examples/react-native-flow/.babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"presets": [
"@babel/preset-flow"
]
}
4 changes: 4 additions & 0 deletions examples/react-native-flow/.flowconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[ignore]
<PROJECT_ROOT>/node_modules/**
[libs]
./flow-typed
11 changes: 11 additions & 0 deletions examples/react-native-flow/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"requirePragma": false,
"printWidth": 80,
"tabWidth": 2,
"useTabs": false,
"semi": false,
"singleQuote": true,
"trailingComma": "es5",
"bracketSpacing": true,
"jsxBracketSameLine": false
}
Loading