Skip to content

Commit f344de7

Browse files
committed
add docs, remove dev notes from readme
1 parent e065f0c commit f344de7

File tree

4 files changed

+21
-15
lines changed

4 files changed

+21
-15
lines changed

README.md

-14
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,3 @@ Examples of parallax with React using [react-scroll-parallax](https://jscottsmit
99
🔗 [Example Site](https://jscottsmith.github.io/react-scroll-parallax-examples/examples/parallax-example/)
1010

1111
🔗 [Parallax Testing](https://jscottsmith.github.io/react-scroll-parallax-examples/examples/parallax-test/)
12-
13-
## Development
14-
15-
Install node modules and start webpack:
16-
17-
`npm i`
18-
19-
Run webpack watch:
20-
21-
`npm run dev`
22-
23-
Run dev server:
24-
25-
`npm run dev-server`

docs/development.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Development
2+
3+
Install node modules and start webpack:
4+
5+
`npm i`
6+
7+
Run webpack watch:
8+
9+
`npm run dev`
10+
11+
Run dev server:
12+
13+
`npm run dev-server`

docs/gh-pages.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Publish to GitHub Pages
2+
3+
Run `npm run gh-pages` for each example root. Swap the root directory in `webpack.config.js`. Push `gh-pages` branch.
4+
5+
Make sure the `<script src="static/bundle.js"></script>` is a relative link to the bundle. On `master` this link should be absolute.

webpack.config.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
// Change this root to point to the desired example when
1+
// Change this root to point to the desired example
2+
23
const EXAMPLE_ROOT = './examples/parallax-example/';
4+
// const EXAMPLE_ROOT = './examples/parallax-test/';
35

46
const createBabelConfig = require('./babelrc');
57
const merge = require('webpack-merge');

0 commit comments

Comments
 (0)