(docs) examples are now moved out of packages

robinweser · Apr 17, 2018 · 3e260fd · 3e260fd
1 parent 41cfec8
commit 3e260fd
Show file tree

Hide file tree

Showing 5 changed files with 117 additions and 117 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -28,53 +28,53 @@
     "**/_book": true,
     "examples/react/bundle.js": true,
     "\\.history/": true,
-    "packages/example-react-native/# OSX": true,
-    "packages/example-react-native/#": true,
-    "packages/example-react-native/.DS_Store": true,
-    "packages/example-react-native/# Xcode": true,
-    "packages/example-react-native/build/": true,
-    "packages/example-react-native/*.pbxuser": true,
-    "packages/example-react-native/!default.pbxuser": true,
-    "packages/example-react-native/*.mode1v3": true,
-    "packages/example-react-native/!default.mode1v3": true,
-    "packages/example-react-native/*.mode2v3": true,
-    "packages/example-react-native/!default.mode2v3": true,
-    "packages/example-react-native/*.perspectivev3": true,
-    "packages/example-react-native/!default.perspectivev3": true,
-    "packages/example-react-native/xcuserdata": true,
-    "packages/example-react-native/*.xccheckout": true,
-    "packages/example-react-native/*.moved-aside": true,
-    "packages/example-react-native/DerivedData": true,
-    "packages/example-react-native/*.hmap": true,
-    "packages/example-react-native/*.ipa": true,
-    "packages/example-react-native/*.xcuserstate": true,
-    "packages/example-react-native/project.xcworkspace": true,
-    "packages/example-react-native/# Android/IJ": true,
-    "packages/example-react-native/*.iml": true,
-    "packages/example-react-native/.idea": true,
-    "packages/example-react-native/.gradle": true,
-    "packages/example-react-native/local.properties": true,
-    "packages/example-react-native/# node.js": true,
-    "packages/example-react-native/node_modules/": true,
-    "packages/example-react-native/npm-debug.log": true,
-    "packages/example-react-native/# BUCK": true,
-    "packages/example-react-native/buck-out/": true,
-    "packages/example-react-native/\\.buckd/": true,
-    "packages/example-react-native/android/app/libs": true,
-    "packages/example-react-native/android/keystores/debug.keystore": true,
-    "packages/example-angular2-typescript/.idea": true,
-    "packages/example-angular2-typescript/node_modules/": true,
-    "packages/example-angular2-typescript/typings/": true,
-    "packages/example-angular2-typescript/*.log": true,
-    "packages/example-angular2/.idea": true,
-    "packages/example-angular2/node_modules": true,
-    "packages/example-angular2/*.log": true,
-    "packages/example-angular2/app/dist": true,
-    "packages/example-angular2-typescript/app/*.js": true,
-    "packages/example-angular2-typescript/app/*.map": true,
-    "packages/example-angular2-typescript/node_modules/express/node_modules/qs/node_modules": true,
-    "packages/example-angular2-typescript/node_modules/express/node_modules/mkdirp/node_modules/": true,
-    "packages/example-angular2-typescript/node_modules/express/node_modules/mkdirp/npm-debug.log": true
+    "examples/example-react-native/# OSX": true,
+    "examples/example-react-native/#": true,
+    "examples/example-react-native/.DS_Store": true,
+    "examples/example-react-native/# Xcode": true,
+    "examples/example-react-native/build/": true,
+    "examples/example-react-native/*.pbxuser": true,
+    "examples/example-react-native/!default.pbxuser": true,
+    "examples/example-react-native/*.mode1v3": true,
+    "examples/example-react-native/!default.mode1v3": true,
+    "examples/example-react-native/*.mode2v3": true,
+    "examples/example-react-native/!default.mode2v3": true,
+    "examples/example-react-native/*.perspectivev3": true,
+    "examples/example-react-native/!default.perspectivev3": true,
+    "examples/example-react-native/xcuserdata": true,
+    "examples/example-react-native/*.xccheckout": true,
+    "examples/example-react-native/*.moved-aside": true,
+    "examples/example-react-native/DerivedData": true,
+    "examples/example-react-native/*.hmap": true,
+    "examples/example-react-native/*.ipa": true,
+    "examples/example-react-native/*.xcuserstate": true,
+    "examples/example-react-native/project.xcworkspace": true,
+    "examples/example-react-native/# Android/IJ": true,
+    "examples/example-react-native/*.iml": true,
+    "examples/example-react-native/.idea": true,
+    "examples/example-react-native/.gradle": true,
+    "examples/example-react-native/local.properties": true,
+    "examples/example-react-native/# node.js": true,
+    "examples/example-react-native/node_modules/": true,
+    "examples/example-react-native/npm-debug.log": true,
+    "examples/example-react-native/# BUCK": true,
+    "examples/example-react-native/buck-out/": true,
+    "examples/example-react-native/\\.buckd/": true,
+    "examples/example-react-native/android/app/libs": true,
+    "examples/example-react-native/android/keystores/debug.keystore": true,
+    "examples/example-angular2-typescript/.idea": true,
+    "examples/example-angular2-typescript/node_modules/": true,
+    "examples/example-angular2-typescript/typings/": true,
+    "examples/example-angular2-typescript/*.log": true,
+    "examples/example-angular2/.idea": true,
+    "examples/example-angular2/node_modules": true,
+    "examples/example-angular2/*.log": true,
+    "examples/example-angular2/app/dist": true,
+    "examples/example-angular2-typescript/app/*.js": true,
+    "examples/example-angular2-typescript/app/*.map": true,
+    "examples/example-angular2-typescript/node_modules/express/node_modules/qs/node_modules": true,
+    "examples/example-angular2-typescript/node_modules/express/node_modules/mkdirp/node_modules/": true,
+    "examples/example-angular2-typescript/node_modules/express/node_modules/mkdirp/npm-debug.log": true
   },
   "files.exclude": {
     "# OS or Editor files": true,
@@ -105,52 +105,52 @@
     "**/_book": true,
     "examples/react/bundle.js": true,
     "\\.history/": true,
-    "packages/example-react-native/# OSX": true,
-    "packages/example-react-native/#": true,
-    "packages/example-react-native/.DS_Store": true,
-    "packages/example-react-native/# Xcode": true,
-    "packages/example-react-native/build/": true,
-    "packages/example-react-native/*.pbxuser": true,
-    "packages/example-react-native/!default.pbxuser": true,
-    "packages/example-react-native/*.mode1v3": true,
-    "packages/example-react-native/!default.mode1v3": true,
-    "packages/example-react-native/*.mode2v3": true,
-    "packages/example-react-native/!default.mode2v3": true,
-    "packages/example-react-native/*.perspectivev3": true,
-    "packages/example-react-native/!default.perspectivev3": true,
-    "packages/example-react-native/xcuserdata": true,
-    "packages/example-react-native/*.xccheckout": true,
-    "packages/example-react-native/*.moved-aside": true,
-    "packages/example-react-native/DerivedData": true,
-    "packages/example-react-native/*.hmap": true,
-    "packages/example-react-native/*.ipa": true,
-    "packages/example-react-native/*.xcuserstate": true,
-    "packages/example-react-native/project.xcworkspace": true,
-    "packages/example-react-native/# Android/IJ": true,
-    "packages/example-react-native/*.iml": true,
-    "packages/example-react-native/.idea": true,
-    "packages/example-react-native/.gradle": true,
-    "packages/example-react-native/local.properties": true,
-    "packages/example-react-native/# node.js": true,
-    "packages/example-react-native/node_modules/": true,
-    "packages/example-react-native/npm-debug.log": true,
-    "packages/example-react-native/# BUCK": true,
-    "packages/example-react-native/buck-out/": true,
-    "packages/example-react-native/\\.buckd/": true,
-    "packages/example-react-native/android/app/libs": true,
-    "packages/example-react-native/android/keystores/debug.keystore": true,
-    "packages/example-angular2-typescript/.idea": true,
-    "packages/example-angular2-typescript/node_modules/": true,
-    "packages/example-angular2-typescript/typings/": true,
-    "packages/example-angular2-typescript/*.log": true,
-    "packages/example-angular2/.idea": true,
-    "packages/example-angular2/node_modules": true,
-    "packages/example-angular2/*.log": true,
-    "packages/example-angular2/app/dist": true,
-    "packages/example-angular2-typescript/app/*.js": true,
-    "packages/example-angular2-typescript/app/*.map": true,
-    "packages/example-angular2-typescript/node_modules/express/node_modules/qs/node_modules": true,
-    "packages/example-angular2-typescript/node_modules/express/node_modules/mkdirp/node_modules/": true,
-    "packages/example-angular2-typescript/node_modules/express/node_modules/mkdirp/npm-debug.log": true
+    "examples/example-react-native/# OSX": true,
+    "examples/example-react-native/#": true,
+    "examples/example-react-native/.DS_Store": true,
+    "examples/example-react-native/# Xcode": true,
+    "examples/example-react-native/build/": true,
+    "examples/example-react-native/*.pbxuser": true,
+    "examples/example-react-native/!default.pbxuser": true,
+    "examples/example-react-native/*.mode1v3": true,
+    "examples/example-react-native/!default.mode1v3": true,
+    "examples/example-react-native/*.mode2v3": true,
+    "examples/example-react-native/!default.mode2v3": true,
+    "examples/example-react-native/*.perspectivev3": true,
+    "examples/example-react-native/!default.perspectivev3": true,
+    "examples/example-react-native/xcuserdata": true,
+    "examples/example-react-native/*.xccheckout": true,
+    "examples/example-react-native/*.moved-aside": true,
+    "examples/example-react-native/DerivedData": true,
+    "examples/example-react-native/*.hmap": true,
+    "examples/example-react-native/*.ipa": true,
+    "examples/example-react-native/*.xcuserstate": true,
+    "examples/example-react-native/project.xcworkspace": true,
+    "examples/example-react-native/# Android/IJ": true,
+    "examples/example-react-native/*.iml": true,
+    "examples/example-react-native/.idea": true,
+    "examples/example-react-native/.gradle": true,
+    "examples/example-react-native/local.properties": true,
+    "examples/example-react-native/# node.js": true,
+    "examples/example-react-native/node_modules/": true,
+    "examples/example-react-native/npm-debug.log": true,
+    "examples/example-react-native/# BUCK": true,
+    "examples/example-react-native/buck-out/": true,
+    "examples/example-react-native/\\.buckd/": true,
+    "examples/example-react-native/android/app/libs": true,
+    "examples/example-react-native/android/keystores/debug.keystore": true,
+    "examples/example-angular2-typescript/.idea": true,
+    "examples/example-angular2-typescript/node_modules/": true,
+    "examples/example-angular2-typescript/typings/": true,
+    "examples/example-angular2-typescript/*.log": true,
+    "examples/example-angular2/.idea": true,
+    "examples/example-angular2/node_modules": true,
+    "examples/example-angular2/*.log": true,
+    "examples/example-angular2/app/dist": true,
+    "examples/example-angular2-typescript/app/*.js": true,
+    "examples/example-angular2-typescript/app/*.map": true,
+    "examples/example-angular2-typescript/node_modules/express/node_modules/qs/node_modules": true,
+    "examples/example-angular2-typescript/node_modules/express/node_modules/mkdirp/node_modules/": true,
+    "examples/example-angular2-typescript/node_modules/express/node_modules/mkdirp/npm-debug.log": true
   }
-}
+}
diff --git a/README.md b/README.md
@@ -125,15 +125,15 @@ render(
 ```
 
 ## Examples
-* [Fela + React](http://fela.js.org/docs/introduction/Examples.html#react) ([source](packages/example-react))
-    * [React Styleguidist](http://fela.js.org/docs/introduction/Examples.html#styleguidist) ([source](packages/example-with-styleguidist))
-    * [React Native](http://fela.js.org/docs/introduction/Examples.html#react-native) ([source](packages/example-react-native))
+* [Fela + React](http://fela.js.org/docs/introduction/Examples.html#react) ([source](examples/example-react))
+    * [React Styleguidist](http://fela.js.org/docs/introduction/Examples.html#styleguidist) ([source](examples/example-with-styleguidist))
+    * [React Native](http://fela.js.org/docs/introduction/Examples.html#react-native) ([source](examples/example-react-native))
     * [ReasonReact](https://github.com/astrada/bs-react-fela-examples)
     * [Next](https://github.com/zeit/next.js/tree/master/examples/with-fela)
-* [Fela + Preact](http://fela.js.org/docs/introduction/Examples.html#preact) ([source](packages/example-preact))
-* [Fela + Inferno](http://fela.js.org/docs/introduction/Examples.html#inferno) ([source](packages/example-inferno))
-* [Fela + Angular 2](http://fela.js.org/docs/introduction/Examples.html#angular-2) ([source](packages/example-angular2))
-    * [TypeScript](http://fela.js.org/docs/introduction/Examples.html#typescript) ([source](packages/example-angular2-typescript))
+* [Fela + Preact](http://fela.js.org/docs/introduction/Examples.html#preact) ([source](examples/example-preact))
+* [Fela + Inferno](http://fela.js.org/docs/introduction/Examples.html#inferno) ([source](examples/example-inferno))
+* [Fela + Angular 2](http://fela.js.org/docs/introduction/Examples.html#angular-2) ([source](examples/example-angular2))
+    * [TypeScript](http://fela.js.org/docs/introduction/Examples.html#typescript) ([source](examples/example-angular2-typescript))
 * [Fela + HyperScript](https://github.com/ahdinosaur/hyper-fela#example)
 * [Fela + Cycle](https://github.com/wcastand/cycle-fela-example)
 

diff --git a/docs/introduction/Examples.md b/docs/introduction/Examples.md
@@ -9,7 +9,7 @@ A simple example application using the [React bindings](https://github.com/rofri
 ```sh
 git clone https://github.com/rofrischmann/fela.git
 
-cd fela/packages/example-react
+cd fela/examples/example-react
 npm install
 # starts the universal rendered application at localhost:8080
 npm start
@@ -34,7 +34,7 @@ Another example that covers the usage with [react-styleguidist](https://github.c
 
 ```sh
 git clone https://github.com/rofrischmann/fela.git
-cd fela/packages/example-with-styleguidist
+cd fela/examples/example-with-styleguidist
 npm install
 npm run styleguide
 ```
@@ -46,7 +46,7 @@ The example is the same as the [React example](#react) above.
 ```sh
 git clone https://github.com/rofrischmann/fela.git
 
-cd fela/packages/example-preact
+cd fela/examples/example-preact
 npm install
 # starts the universal rendered application at localhost:8080
 npm start
@@ -62,7 +62,7 @@ The example is the same as the [React example](#react) above.
 ```sh
 git clone https://github.com/rofrischmann/fela.git
 
-cd fela/packages/example-inferno
+cd fela/examples/example-inferno
 npm install
 # starts the universal rendered application at localhost:8080
 npm start
@@ -77,7 +77,7 @@ A simple example application using the [React bindings](https://github.com/rofri
 ```sh
 git clone https://github.com/rofrischmann/fela.git
 
-cd fela/packages/example-react-native
+cd fela/examples/example-react-native
 npm install
 npm start
 ```
@@ -96,7 +96,7 @@ The code examples are based on the build-chain as used in [Angular 2 ESNext Todo
 
 ```sh
 git clone https://github.com/rofrischmann/fela.git
-cd fela/packages/example-angular2
+cd fela/examples/example-angular2
 npm install
 npm run start
 ```
@@ -110,7 +110,7 @@ npm run start
 The same example is also available in TypeScript. It also covers Fela typings.
 ```sh
 git clone https://github.com/rofrischmann/fela.git
-cd fela/packages/example-angular2-typescript
+cd fela/examples/example-angular2-typescript
 npm install
 npm run start
 ```
diff --git a/examples/example-with-styleguidist/Readme.md b/examples/example-with-styleguidist/Readme.md
@@ -4,7 +4,7 @@ How to start locally:
 
 ```
 git clone https://github.com:rofrischmann/fela.git
-cd packages/example-with-styleguidist
+cd examples/example-with-styleguidist
 npm install
 npm run styleguide
 ```

diff --git a/packages/fela/README.md b/packages/fela/README.md
@@ -125,15 +125,15 @@ render(
 ```
 
 ## Examples
-* [Fela + React](http://fela.js.org/docs/introduction/Examples.html#react) ([source](packages/example-react))
-    * [React Styleguidist](http://fela.js.org/docs/introduction/Examples.html#styleguidist) ([source](packages/example-with-styleguidist))
-    * [React Native](http://fela.js.org/docs/introduction/Examples.html#react-native) ([source](packages/example-react-native))
+* [Fela + React](http://fela.js.org/docs/introduction/Examples.html#react) ([source](examples/example-react))
+    * [React Styleguidist](http://fela.js.org/docs/introduction/Examples.html#styleguidist) ([source](examples/example-with-styleguidist))
+    * [React Native](http://fela.js.org/docs/introduction/Examples.html#react-native) ([source](examples/example-react-native))
     * [ReasonReact](https://github.com/astrada/bs-react-fela-examples)
     * [Next](https://github.com/zeit/next.js/tree/master/examples/with-fela)
-* [Fela + Preact](http://fela.js.org/docs/introduction/Examples.html#preact) ([source](packages/example-preact))
-* [Fela + Inferno](http://fela.js.org/docs/introduction/Examples.html#inferno) ([source](packages/example-inferno))
-* [Fela + Angular 2](http://fela.js.org/docs/introduction/Examples.html#angular-2) ([source](packages/example-angular2))
-    * [TypeScript](http://fela.js.org/docs/introduction/Examples.html#typescript) ([source](packages/example-angular2-typescript))
+* [Fela + Preact](http://fela.js.org/docs/introduction/Examples.html#preact) ([source](examples/example-preact))
+* [Fela + Inferno](http://fela.js.org/docs/introduction/Examples.html#inferno) ([source](examples/example-inferno))
+* [Fela + Angular 2](http://fela.js.org/docs/introduction/Examples.html#angular-2) ([source](examples/example-angular2))
+    * [TypeScript](http://fela.js.org/docs/introduction/Examples.html#typescript) ([source](examples/example-angular2-typescript))
 * [Fela + HyperScript](https://github.com/ahdinosaur/hyper-fela#example)
 * [Fela + Cycle](https://github.com/wcastand/cycle-fela-example)