Skip to content

Commit a5251b4

Browse files
committed
chore(docs): update homepage copy and make sidebar auto-generated
1 parent e524ded commit a5251b4

File tree

8 files changed

+16
-117
lines changed

8 files changed

+16
-117
lines changed

website/docs/components/chart.mdx

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

website/docs/components/docs.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

website/docs/components/index.mdx

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

website/docs/docs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
exports.docs = [
22
{ title: "Quick Walkthrough", slug: "/docs/quick-walkthrough" },
3-
{ title: "Sponsor", slug: "/docs/sponsor" },
3+
{ title: "Examples", slug: "/examples" },
44
];

website/docs/index.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
---
22
slug: /
3-
description: A thin, typed, React wrapper for Google Charts
3+
description: A thin, typed, React wrapper for Google Charts. Supports 25+ chart types.
44
---
55

6-
import logoUrl from '@site/static/img/logo.png';
6+
import logoUrl from "@site/static/img/logo.png";
77

88
# React Google Charts
99

10-
<img src={logoUrl} alt='Logo' className='logo' />
10+
<img src={logoUrl} alt="Logo" className="logo" />
1111

1212
A thin, typed, React wrapper for [Google Charts](https://developers.google.com/chart/interactive/docs/reference).
1313

14+
Supports 25+ chart types.
15+
1416
[![version](https://img.shields.io/npm/v/react-google-charts.svg)](https://www.npmjs.com/package/react-google-charts)
1517
[![downloads](https://img.shields.io/npm/dm/react-google-charts.svg)](https://www.npmjs.com/package/react-google-charts)
1618
[![license](https://shields.io/badge/license-MIT-green)](http://opensource.org/licenses/MIT)
@@ -20,12 +22,6 @@ A thin, typed, React wrapper for [Google Charts](https://developers.google.com/c
2022

2123
Install this library with your favorite package manager:
2224

23-
```bash
24-
yarn add react-google-charts
25-
```
26-
27-
or
28-
2925
```bash
3026
npm install --save react-google-charts
3127
```
@@ -37,11 +33,15 @@ import { Chart } from "react-google-charts";
3733

3834
<Chart
3935
chartType="ScatterChart"
40-
data={[["Age", "Weight"], [4, 5.5], [8, 12]]}
36+
data={[
37+
["Age", "Weight"],
38+
[4, 5.5],
39+
[8, 12],
40+
]}
4141
width="100%"
4242
height="400px"
4343
legendToggle
44-
/>
44+
/>;
4545
```
4646

4747
## Examples

website/docs/sponsor.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
slug: /docs/sponsor
3-
description: supported and maintained by cube
3+
description: Interested in sponsoring ? Reach out.
44
---
55

6-
# Sponsor
6+
If you are interested in sponsoring this library please reach out.
77

8-
This library is maintained by the creators of [Cube](https://cube.dev/?ref=eco-react-google-charts), the headless business intelligence for building powerful, fast, and consistent data applications.
8+
### History
99

10-
Need an API to fetch data? Consider Cube, it [works great](https://cube.dev/blog/react-google-charts-dashboard/?ref=eco-react-google-charts) with React Google Charts.
10+
- [Cube](https://cube.dev/?ref=eco-react-google-charts) helped migrate the docs section to Docusaurus in 2021.

website/docusaurus.config.js

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ const config = {
3636
},
3737
docs: {
3838
routeBasePath: "/",
39-
sidebarPath: require.resolve("./sidebars.js"),
4039
editUrl:
4140
"https://github.com/RakanNimer/react-google-charts/edit/master/website/",
4241
},
@@ -57,12 +56,6 @@ const config = {
5756
src: "img/logo.png",
5857
},
5958
items: [
60-
{
61-
type: "doc",
62-
docId: "components/index",
63-
position: "left",
64-
label: "Components",
65-
},
6659
{
6760
type: "doc",
6861
docId: "examples/index",

website/sidebars.js

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

0 commit comments

Comments
 (0)