Skip to content

Commit 7dc58ec

Browse files
authored
Merge pull request #44 from microlinkhq/docs
docs: better home
2 parents 11b0dae + 03bbc70 commit 7dc58ec

35 files changed

+61
-242
lines changed

.gitignore

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
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
10+
.DS_Store

.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 renamed to LICENSE.md

File renamed without changes.

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
12
<h1 align="center">
2-
<a href="https://react-json-view.microlink.io/"><img src="https://github.com/raw/microlinkhq/react-json-view/master/doc/rjv-icon-alt.png" alt="react-json-view" width="200"></a>
3+
<a href="https://react-json-view.microlink.io/">
4+
<img src="https://github.com/raw/microlinkhq/react-json-view/master/doc/rjv-icon-alt.png" alt="react-json-view" width="200"></a>
35
<br>
46
react-json-view
57
<br>
@@ -11,10 +13,7 @@
1113

1214
**react-json-view** (rjv) is a React component for displaying and editing javascript **arrays** and **JSON objects**.
1315

14-
<div style="display: flex;">
15-
<img src="https://github.com/raw/microlinkhq/react-json-view/master/doc/output-example-15.png" alt="Output Example 1" style="width: 50%;">
16-
<img src="https://github.com/raw/microlinkhq/react-json-view/master/doc/output-example-14.png" alt="Output Example 2" style="width: 50%;">
17-
</div>
16+
![](https://github.com/raw/microlinkhq/react-json-view/docs/docs/assets/banner.png)
1817

1918
### Highlights
2019

@@ -158,3 +157,10 @@ Check [react-json-view.microlink.io](https://react-json-view.microlink.io/) to s
158157
**rjv** supports any base-16 theme. You can supply your own base-16 theme object.
159158

160159
To better understand custom themes, take a look at [my example implementation](https://github.com/microlinkhq/react-json-view/blob/7c154b9a7d83ea89dce2c171ebdf4d163ff49233/dev-server/src/index.js#L135) and the [base-16 theme styling guidelines](https://github.com/chriskempson/base16/blob/master/styling.md).
160+
161+
## License
162+
163+
**react-json-view** © [microlink.io](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/cards/blob/master/LICENSE.md) License.<br>
164+
Authored by [Mac Gainor](https://github.com/mac-s-g) and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/microlinkhq/cards/contributors).
165+
166+
> [microlink.io](https://microlink.io) · GitHub [microlink.io](https://github.com/microlinkhq) · X [@microlinkhq](https://x.com/microlinkhq)

demo/dist/index.html

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

demo/dist/main.js

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

doc/edit-complete-1.png

-8.5 KB
Binary file not shown.

doc/edit-init-1.png

-9.48 KB
Binary file not shown.

doc/edit-input-1.png

-8.94 KB
Binary file not shown.

0 commit comments

Comments
 (0)