Skip to content

Commit c39c93d

Browse files
committed
docs: better home
1 parent 11b0dae commit c39c93d

37 files changed

+11
-32
lines changed

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
*.swp
22
npm-debug.log
3-
43
/coverage
54
/debug
65
/dist
76
/node_modules
8-
97
.nyc_output
10-
.envrc
8+
.envrc
9+
docs/dist

.npmignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,12 @@ npm-debug.log
88
/demo
99
/dev-server
1010
/doc
11-
/docker
1211
/entrypoints
1312
/node_modules
1413
/src
1514
/test
1615
/webpack
1716

18-
Dockerfile
1917
.babelrc
2018
.coveralls.yml
2119
.gitignore

CONTRIBUTING.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,3 @@ npm run build
2121
Please add tests for your code before posting a pull request.
2222

2323
You can run the test suite with `npm run test` or `npm run test:watch` to automatically reload when files are modified.
24-
25-
## Docker Tools
26-
27-
I recommend using docker for development because it enforces environmental consistency.
28-
29-
For information about contributing with Docker, see the [README in ./docker](https://github.com/microlinkhq/react-json-view/blob/master/docker/README.md#contributing-to-this-project-using-docker).

LICENSE.md

Whitespace-only changes.

demo/dist/main.js

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/.DS_Store

6 KB
Binary file not shown.

docs/assets/demo.png

554 KB
Loading
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

demo/dist/index.html renamed to docs/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@
9797
</a>
9898
</div>
9999
</div>
100-
<script type="text/javascript" src="./main.js"></script>
100+
<script type="text/javascript" src="./dist/main.js"></script>
101101
</body>
102102
</html>
103+

docs/src/.DS_Store

6 KB
Binary file not shown.

docs/src/js/.DS_Store

6 KB
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/src/style/.DS_Store

6 KB
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -265,12 +265,11 @@
265265
"scripts": {
266266
"build": "NODE_OPTIONS=--openssl-legacy-provider NODE_ENV=production webpack --config webpack/webpack.config.js --progress",
267267
"dev": "NODE_ENV=development webpack serve --config webpack/webpack.config-dev.js --open",
268-
"docs:build": "NODE_ENV=production webpack --node-env production --config webpack/webpack.config-demo.js --progress",
268+
"docs:build": "NODE_ENV=production webpack --node-env production --config webpack/webpack.config-docs.js --progress",
269269
"docs:dev": "tinyrun 'npm run docs:dev:watch' 'npm run docs:dev:browserync'",
270270
"docs:dev:watch": "npm run docs:build -- --watch",
271-
"docs:dev:browserync": "browser-sync start --serveStatic demo/dist/ --server --files 'index.html, **/*.(css|js|md)'",
271+
"docs:dev:browserync": "browser-sync start --serveStatic docs/ --server --files 'index.html, **/*.(css|js|md)'",
272272
"lint": "standard",
273-
"modules:debug": "./docker/debug.sh",
274273
"modules:size-analyzer": "webpack --config webpack/webpack.config.js --json | webpack-bundle-size-analyzer",
275274
"modules:tree": "webpack --config webpack/webpack.config.js --json ",
276275
"postrelease": "npm run release:tags && npm run release:github && npm publish",

webpack/webpack.config-demo.js renamed to webpack/webpack.config-docs.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@ const PATHS = {
55
src: path.join(__dirname, '..', 'src'),
66
js: path.join(__dirname, '..', 'src', 'js'),
77
style: path.join(__dirname, '..', 'src', 'style'),
8-
build: path.join(__dirname, '..', 'demo', 'dist'),
9-
demo: path.join(__dirname, '..', 'demo')
8+
build: path.join(__dirname, '..', 'docs', 'dist'),
9+
docs: path.join(__dirname, '..', 'docs')
1010
}
1111

1212
const config = {
1313
mode: 'production',
14-
entry: [PATHS.demo + '/src/js/entry.js'],
14+
entry: [PATHS.docs + '/src/js/entry.js'],
1515
externals: {
1616
react: 'React',
1717
'react-dom': 'ReactDOM'
1818
},
1919
output: {
20-
path: PATHS.demo + '/dist',
20+
path: PATHS.docs + '/dist',
2121
filename: 'main.js',
2222
library: 'reactJsonView',
2323
libraryTarget: 'umd'
@@ -34,7 +34,7 @@ const config = {
3434
loader: 'babel-loader'
3535
}
3636
],
37-
include: [PATHS.js, PATHS.demo]
37+
include: [PATHS.js, PATHS.docs]
3838
},
3939
{
4040
test: /\.s?css$/,

0 commit comments

Comments
 (0)