{"id":19448288,"url":"https://github.com/csbun/gitbook-plugin-chart","last_synced_at":"2025-04-25T02:30:57.657Z","repository":{"id":71511417,"uuid":"45449626","full_name":"csbun/gitbook-plugin-chart","owner":"csbun","description":"Using C3.js or Highcharts chart library in Gitbook.","archived":false,"fork":false,"pushed_at":"2022-09-21T17:08:57.000Z","size":240,"stargazers_count":11,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-03T15:04:41.809Z","etag":null,"topics":["chart","gitbook"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csbun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-03T07:36:47.000Z","updated_at":"2022-07-28T05:42:08.000Z","dependencies_parsed_at":"2023-02-23T17:45:18.862Z","dependency_job_id":null,"html_url":"https://github.com/csbun/gitbook-plugin-chart","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csbun%2Fgitbook-plugin-chart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csbun%2Fgitbook-plugin-chart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csbun%2Fgitbook-plugin-chart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csbun%2Fgitbook-plugin-chart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csbun","download_url":"https://codeload.github.com/csbun/gitbook-plugin-chart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250741894,"owners_count":21479689,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chart","gitbook"],"created_at":"2024-11-10T16:25:51.454Z","updated_at":"2025-04-25T02:30:57.652Z","avatar_url":"https://github.com/csbun.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gitbook-plugin-chart\n\nUsing [C3.js](http://c3js.org/) or [Highcharts](http://www.highcharts.com/) chart library in Gitbook.\n\n## Config\n\n### Chart Library\n\nConfig in `book.json`:\n\n```json\n{\n  \"plugins\": [ \"chart\" ],\n  \"pluginsConfig\": {\n      \"chart\": {\n          \"type\": \"highcharts\"\n      }\n  }\n}\n```\n\n`type` can be `c3` or `highcharts`, default to `c3`.\n\n## Usage\n\nInsert block in your markdown file.\n\n**Caution**: the content of the blocks should be written in pure JSON. That is, each property should be quoted, and you should strictly use double quotes `\"`, not single quotes `'`:\n```JSON\n// Invalid JSON\n{\n    data: {\n        type: 'bar'\n    }\n}\n\n// Valid JSON\n{\n    \"data\": {\n        \"type\": \"bar\"\n    }\n}\n```\n\nSee the examples below.\n\n### Example for [C3.js](http://c3js.org/)\n\nYou **SHOULD NOT** specify the `bindto` property for the chart.\n\n```\n{% chart %}\n{\n    \"data\": {\n        \"type\": \"bar\",\n        \"columns\": [\n            [\"data1\", 30, 200, 100, 400, 150, 1500, 2500],\n            [\"data2\", 50, 100, 300, 450, 650, 250, 1320]\n        ]\n    },\n    \"axis\": {\n        \"y\": {\n            \"tick\": {\n                \"format\": d3.format(\"$,\")\n            }\n        }\n    }\n}\n{% endchart %}\n```\n\nGetting Start with [C3.js](http://c3js.org/gettingstarted.html#customize).\n\n### Example for C3.js in [YAML](http://yaml.org/)\n\n```\n{% chart format=\"yaml\" %}\ndata:\n    type: bar\n    columns:\n        - [data1, 30, 200, 100, 400, 150, 250]\n        - [data2, 50, 20, 10, 40, 15, 25]\n    axes:\n        data2: y2\naxis:\n    y2:\n        show: true\n{% endchart %}\n```\n\n### Example for [Highcharts](http://www.highcharts.com/)\n\nYou **SHOULD NOT** specify the `renderTo` property for the chart.\n\n```\n{% chart %}\n{\n    \"chart\": {\n        \"type\": \"bar\"\n    },\n    \"title\": {\n        \"text\": \"Fruit Consumption\"\n    },\n    \"xAxis\": {\n        \"categories\": [\"Apples\", \"Bananas\", \"Oranges\"]\n    },\n    \"yAxis\": {\n        \"title\": {\n            \"text\": \"Fruit eaten\"\n        }\n    },\n    \"series\": [{\n        \"name\": \"Jane\",\n        \"data\": [1, 0, 4]\n    }, {\n        \"name\": \"John\",\n        \"data\": [5, 7, 3]\n    }]\n}\n{% endchart %}\n```\n\nGetting Start with [Highcharts](http://www.highcharts.com/docs/getting-started/your-first-chart).\n\n## Development\n\nLearn more about [Gitbook Plugin](https://toolchain.gitbook.com/plugins/testing.html)\n\n### Prepare\n\nTesting your plugin on your book before publishing it is possible using npm link.\n\nIn the plugin's folder, run:\n\n```\nnpm link\n```\n\nThen in the _test_ folder:\n\n```\nnpm link gitbook-plugin-chart\n```\n\n### Start\n\nIn the plugin's folder, run:\n\n```\nnpm run dev\n```\n\nThen in the _test_ folder:\n\n```\nnpm start\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsbun%2Fgitbook-plugin-chart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsbun%2Fgitbook-plugin-chart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsbun%2Fgitbook-plugin-chart/lists"}