Skip to content

discussion: Add some example docs for docusaurus #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: docusaurus
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/api/caption.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: caption
title: Caption
sidebar_label: Caption
---

The chart's caption, which will render below the chart.

[ Highcharts caption reference](https://api.highcharts.com/highcharts/caption)

## Usage

```jsx
<HighchartsChart>
<Caption align="center">
This is center aligned caption.
</Caption>
</HighchartsChart>
```
18 changes: 18 additions & 0 deletions docs/api/mapnavigation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
id: map-navigation
title: MapNavigation
sidebar_label: MapNavigation
---

[ Highmaps mapnavigation reference](https://api.highcharts.com/highmaps/mapNavigation)

## Usage

```jsx
<HighchartsMapChart map={data}>
<MapNavigation>
<MapNavigation.ZoomIn />
<MapNavigation.ZoomOut />
</MapNavigation>
</HighchartsMapChart>
```
36 changes: 36 additions & 0 deletions docs/api/navigator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
id: navigator
title: Navigator
sidebar_label: Navigator
---

The navigator is a small series below the main series, displaying a view of the entire data set. It provides tools to zoom in and out on parts of the data as well as panning across the dataset.

[ Highstock navigator reference](https://api.highcharts.com/highstock/navigator)

## Usage

```jsx
<HighchartsStockChart>
<Chart zoomType="x" />

<XAxis>
<XAxis.Title>Time</XAxis.Title>
</XAxis>

<YAxis>
<YAxis.Title>Price</YAxis.Title>
<AreaSplineSeries id="profit" name="Profit" data={data1} />
</YAxis>

<YAxis opposite>
<YAxis.Title>Social Buzz</YAxis.Title>
<SplineSeries id="twitter" name="Twitter mentions" data={data2} />
</YAxis>

<Navigator>
<Navigator.Series seriesId="profit" />
<Navigator.Series seriesId="twitter" />
</Navigator>
</HighchartsStockChart>
```
13 changes: 13 additions & 0 deletions docs/getting-started/react-jsx-highcharts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: react-jsx-highcharts
title: Getting Started
sidebar_label: react-jsx-highcharts
---

## Installation

`npm install --save react-jsx-highcharts`

You'll need the peer dependencies too

`npm install --save react react-dom prop-types highcharts@^7.0.0`
13 changes: 13 additions & 0 deletions docs/getting-started/react-jsx-highmaps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: react-jsx-highmaps
title: Getting Started
sidebar_label: react-jsx-highmaps
---

## Installation

`npm install --save react-jsx-highmaps`

You'll need the peer dependencies too

`npm install --save react react-dom prop-types highcharts@^7.0.0`
13 changes: 13 additions & 0 deletions docs/getting-started/react-jsx-highstock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: react-jsx-highstock
title: Getting Started
sidebar_label: react-jsx-highstock
---

## Installation

`npm install --save react-jsx-highstock`

You'll need the peer dependencies too

`npm install --save react react-dom prop-types highcharts@^7.0.0`
19 changes: 14 additions & 5 deletions website/sidebars.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
{
"docs": {
"Docusaurus": ["doc1"],
"First Category": ["doc2"],
"Second Category": ["doc3"]
},
"docs-other": {
"First Category": ["doc4", "doc5"]
"Getting Started": [
"getting-started/react-jsx-highcharts",
"getting-started/react-jsx-highmaps",
"getting-started/react-jsx-highstock"
],
"Highcharts Components": [
"api/caption"
],
"Highmaps Components": [
"api/map-navigation"
],
"Highstock Components": [
"api/navigator"
]
}
}