Skip to content

Commit

Permalink
docs: better home
Browse files Browse the repository at this point in the history
  • Loading branch information
Kikobeats committed Oct 23, 2024
1 parent 11b0dae commit 81ee5ab
Show file tree
Hide file tree
Showing 37 changed files with 11 additions and 30 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ npm-debug.log
/node_modules

.nyc_output
.envrc
.envrc
docs/dist
2 changes: 0 additions & 2 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@ npm-debug.log
/demo
/dev-server
/doc
/docker
/entrypoints
/node_modules
/src
/test
/webpack

Dockerfile
.babelrc
.coveralls.yml
.gitignore
Expand Down
6 changes: 0 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,3 @@ npm run build
Please add tests for your code before posting a pull request.

You can run the test suite with `npm run test` or `npm run test:watch` to automatically reload when files are modified.

## Docker Tools

I recommend using docker for development because it enforces environmental consistency.

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).
Empty file added LICENSE.md
Empty file.
12 changes: 0 additions & 12 deletions demo/dist/main.js

This file was deleted.

Binary file added docs/.DS_Store
Binary file not shown.
Binary file added docs/assets/demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
File renamed without changes
File renamed without changes
3 changes: 2 additions & 1 deletion demo/dist/index.html → docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
</a>
</div>
</div>
<script type="text/javascript" src="./main.js"></script>
<script type="text/javascript" src="./dist/main.js"></script>
</body>
</html>

Binary file added docs/src/.DS_Store
Binary file not shown.
Binary file added docs/src/js/.DS_Store
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file added docs/src/style/.DS_Store
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -265,12 +265,11 @@
"scripts": {
"build": "NODE_OPTIONS=--openssl-legacy-provider NODE_ENV=production webpack --config webpack/webpack.config.js --progress",
"dev": "NODE_ENV=development webpack serve --config webpack/webpack.config-dev.js --open",
"docs:build": "NODE_ENV=production webpack --node-env production --config webpack/webpack.config-demo.js --progress",
"docs:build": "NODE_ENV=production webpack --node-env production --config webpack/webpack.config-docs.js --progress",
"docs:dev": "tinyrun 'npm run docs:dev:watch' 'npm run docs:dev:browserync'",
"docs:dev:watch": "npm run docs:build -- --watch",
"docs:dev:browserync": "browser-sync start --serveStatic demo/dist/ --server --files 'index.html, **/*.(css|js|md)'",
"docs:dev:browserync": "browser-sync start --serveStatic docs/ --server --files 'index.html, **/*.(css|js|md)'",
"lint": "standard",
"modules:debug": "./docker/debug.sh",
"modules:size-analyzer": "webpack --config webpack/webpack.config.js --json | webpack-bundle-size-analyzer",
"modules:tree": "webpack --config webpack/webpack.config.js --json ",
"postrelease": "npm run release:tags && npm run release:github && npm publish",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ const PATHS = {
src: path.join(__dirname, '..', 'src'),
js: path.join(__dirname, '..', 'src', 'js'),
style: path.join(__dirname, '..', 'src', 'style'),
build: path.join(__dirname, '..', 'demo', 'dist'),
demo: path.join(__dirname, '..', 'demo')
build: path.join(__dirname, '..', 'docs', 'dist'),
docs: path.join(__dirname, '..', 'docs')
}

const config = {
mode: 'production',
entry: [PATHS.demo + '/src/js/entry.js'],
entry: [PATHS.docs + '/src/js/entry.js'],
externals: {
react: 'React',
'react-dom': 'ReactDOM'
},
output: {
path: PATHS.demo + '/dist',
path: PATHS.docs + '/dist',
filename: 'main.js',
library: 'reactJsonView',
libraryTarget: 'umd'
Expand All @@ -34,7 +34,7 @@ const config = {
loader: 'babel-loader'
}
],
include: [PATHS.js, PATHS.demo]
include: [PATHS.js, PATHS.docs]
},
{
test: /\.s?css$/,
Expand Down

0 comments on commit 81ee5ab

Please sign in to comment.