This plugin enhances your Docsify documentation by adding SVG charts to your website. It allows you to add in multiple types of charts, including pie, doughnut, sectional, radar, area, scatter, line, and bar types. By utilising this plugin, you can easily show your data in a beautiful interface.

Installation

$3

Assuming you have a working docsify framework set up, it is easy to use the plugin.

1. Add the following script and stylesheet to your index.html via either CDN or downloading it and using it locally:

``html







`

1. In docsify setup, configure the plugin:

`js

`

Configuration

There are several options available for the docsify-charty plugin:

> Example: index.html

| Name | Type | Example | Description |
|---------|-----------|-----------|-------------------------------------------|
| theme | String | "#EE5599" | Global theme for chart colours in HEX |
| mode | String | "light" | Accepts "dark" or "light" |
| debug | Boolean | false | Console logs if charts aren't loading |

$3

| Name | Accepts | Description |
|-------------------|---------------|------------------------------------------|
| title | String | The title of the chart, displayed at the top. Leave blank if you want to hide it |
| caption | String | The sub-text of the chart, displayed under the title. Leave blank to hide it |
| type | String | The type of charty you want to display |
| options.theme | String | Set an individual theme to this chart. It will override the global theme |
| options.legend | Boolean | Show the legend. Default true |
| options.labels | Boolean | Show the chart labels. Default true |
| options.numbers | Boolean | Show the chart numbers. Default true |
| data.label | String | Graphed data point label |
| data.value | Int / Array | Graphed value that puts it on the render |
| data.colour | String | Override the global and theme with a specific colour |

$3

`js
`charty
{
"title": '',
"caption": '',
"type": '',
"options": {
"theme": '',
"legend": '',
"labels": '',
"numbers": ''
},
"data": [
{
"label": '',
"value": '',
"colour": ''
}
]
}
\\\
``

Types of charts

$3

#### Pie chart

!docsify-charty: pie

#### Donut / Doughnut chart

!docsify-charty: donut

#### Section / Sectional chart

!docsify-charty: section

#### Rings chart

!docsify-charty: rings

$3

#### Radar chart

!docsify-charty: radar

#### Area chart

!docsify-charty: area

$3

#### Scatter chart

!docsify-charty: scatter

#### Bubble chart

!docsify-charty: bubble

#### Line chart

!docsify-charty: line

!docsify-charty: line

$3

$3

!docsify-charty: line

!docsify-charty: line

$3

!docsify-charty: line

!docsify-charty: line

$3

!docsify-charty: line

Contributing

1. Clone the repo: git clone https://github.com/markbattistella/docsify-charty.git

1. Create your feature branch: git checkout -b my-feature

1. Commit your changes: git commit -am 'Add some feature'

1. Push to the branch: git push origin my-new-feature

1. Submit the pull` request