{"id":16131804,"url":"https://github.com/bcopy/gitbook-plugin-datatables","last_synced_at":"2025-04-06T14:41:08.030Z","repository":{"id":73468546,"uuid":"541574782","full_name":"bcopy/gitbook-plugin-datatables","owner":"bcopy","description":"DataTables plugin for Gitbook / Honkit","archived":false,"fork":false,"pushed_at":"2022-11-10T14:33:10.000Z","size":489,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-02-12T20:43:27.394Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/bcopy.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":"2022-09-26T12:28:03.000Z","updated_at":"2022-09-27T13:45:08.000Z","dependencies_parsed_at":"2023-04-18T07:31:36.297Z","dependency_job_id":null,"html_url":"https://github.com/bcopy/gitbook-plugin-datatables","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcopy%2Fgitbook-plugin-datatables","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcopy%2Fgitbook-plugin-datatables/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcopy%2Fgitbook-plugin-datatables/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcopy%2Fgitbook-plugin-datatables/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bcopy","download_url":"https://codeload.github.com/bcopy/gitbook-plugin-datatables/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247500270,"owners_count":20948874,"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":[],"created_at":"2024-10-09T22:27:16.109Z","updated_at":"2025-04-06T14:41:07.987Z","avatar_url":"https://github.com/bcopy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Gitbook Plugin for DataTables\n\nThis plugin integrates [DataTables](https://datatables.net/) in your ~~Gitbook~~ Honkit website, with support for accessible HTML tables.\n\nWith regards to support for dynamic data source, note that the plugin can only inject data available at *build time*, when ~~Gitbook~~ Honkit generates your static website.\n\n## Installation\n\n* Install the plugin\n ```\n npm install bcopy/gitbook-plugin-datatables\n ```\n\n* Add the plugin to your `book.json`, for example :\n\n```json\n{\n  \"plugins\": [\"datatables\"],\n  (...)\n  \"pluginsConfig\":{\n    \"datatables\":{\n            \"config-url\" : \"/data/dtconfig.json\",\n            \"default-config\": {\"pageLength\": 50 }\n    }\n  }\n}\n```\n\n## DataTables Configuration\n\nIn order to configure your datatables, you can use [inline HTML 5 data attributes](https://datatables.net/manual/options#HTML-5-data-attributes) for simple cases, or provide a JSON object associating a CSS selector with the datatable configuration you wish to see applied to matching DOM elements.\nFor it to work, your JSON file must be valid, as in the example below.\n\nFor instance, to configure an HTML table bearing the ID \"accounting\", you could use :\n\n```json\n{\n   \"#accounting\":{\n      \"ajax\":\"/data/objects.txt\",\n      \"columns\":[\n         { \"data\":\"name\" },\n         { \"data\":\"position\" },\n         { \"data\":\"office\" },\n         { \"data\":\"extn\" },\n         { \"data\":\"start_date\" },\n         { \"data\":\"salary\" }\n      ],\n      \"order\":[ [ 2, \"asc\" ] ],\n      \"rowGroup\":{ \"dataSrc\":\"office\" }\n   }\n}\n```\n\n## Features\n\n* Please refer to [https://datatables.net/](https://datatables.net/) for its full and exhaustive list of features.\n\n\n## How to develop the plugin\n\n### Development environment installation\n\n* Prerequisites\n  * You will need a JDK v11+\n\n* You can use the provided Gradle wrapper to install node locally (Alternatively you must have node v14+ installed)\n  * ```./gradlew installNode``` on Linux / Mac OSX\n  * or ```gradlew.bat installNode``` on Windows\n* You can then setup your path and install the required dependencies :\n  * If using the gradle wrapper : ```source ./setup-path.sh```\n  * ```npm install```\n* Finally you can run the book in preview mode\n  * ```npm run serve```\n\nAlternatively, you can install NodeJS locally.\n\n### Gitflow support in Gradle\n\n* Init gitflow\n\n```\n./gradlew initGitflow\n```\n\n* Develop a new feature with\n\n```\n./gradlew featureStart\n./gradlew featureFinish\n````\n\n* Issue a new release with\n\n```\n./gradlew releaseStart\n./gradlew releaseFinish\n````\n\nPlease refer to https://github.com/hyasinfosec/gitflow-gradle-plugin\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcopy%2Fgitbook-plugin-datatables","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbcopy%2Fgitbook-plugin-datatables","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcopy%2Fgitbook-plugin-datatables/lists"}