{"id":18678132,"url":"https://github.com/zingchart/gitbook-plugin-include-display-run","last_synced_at":"2025-11-07T09:30:33.326Z","repository":{"id":85225106,"uuid":"62752502","full_name":"zingchart/gitbook-plugin-include-display-run","owner":"zingchart","description":"Plugin for Gitbook that displays and runs code from external file.","archived":false,"fork":false,"pushed_at":"2021-02-22T18:39:40.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-01-28T05:15:23.261Z","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/zingchart.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":"2016-07-06T20:52:03.000Z","updated_at":"2021-02-22T18:39:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"22641a72-42e8-4b50-87c2-497aab5caac5","html_url":"https://github.com/zingchart/gitbook-plugin-include-display-run","commit_stats":{"total_commits":2,"total_committers":2,"mean_commits":1.0,"dds":0.5,"last_synced_commit":"b6d88a932ce46c6600f23edf4df47c35a6f628c7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zingchart%2Fgitbook-plugin-include-display-run","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zingchart%2Fgitbook-plugin-include-display-run/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zingchart%2Fgitbook-plugin-include-display-run/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zingchart%2Fgitbook-plugin-include-display-run/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zingchart","download_url":"https://codeload.github.com/zingchart/gitbook-plugin-include-display-run/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239525498,"owners_count":19653337,"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-11-07T09:36:08.145Z","updated_at":"2025-11-07T09:30:33.279Z","avatar_url":"https://github.com/zingchart.png","language":"JavaScript","readme":"# 2021 UPDATE:\n\n**This plugin is no longer maintained. It will not work with newer versions of GitBook. This repository exists purely for historical reasons. No further updates will be made.**\n\n\nGitBook Plugin to display and run included files.\n==============\n\n### 1. You can use install it via **NPM** and save it to package.json:\n```\n$ npm install gitbook-plugin-include-display-run --save\n```\n### 2. Add the plugin to `book.json` config\n```\n{\n    \"plugins\": [ \"include-display-run\"]\n}\n```\n\n### 3. Include displayrun block in your markdown files.\n```\n{% displayrun src='../HTML/4Elements/forms/select.html' %}\n{% enddisplayrun %}\n```\n\n```\n{% displayrun   src='../HTML/4Elements/forms/input.html', display='editor',\n                language='javascript', readOnly='true', theme='github' %}\n{% enddisplayrun %}\n```\n\n```\n{% displayrun src='../HTML/4Elements/forms/meter.html', display='run' %}\n{% enddisplayrun %}\n```\n\n#### General Attributes\n\n* `src` *required* - The relative path to the file that will be displayed in the editor and run in page.\n* `display` *optional* - Indicates how the code is included in the page.  Options are: `['both', 'editor', 'run']`\n\t* default: `both`\n* `separator` *optional* - Any text/HTML that should be used between the editor and the executed code if the `display` option is set to `both`\n\t* default: `\u003chr\u003e`\n\n#### Editor Attributes\n\nWe are using an ACE editor for the editor.  We currently support the following attributes.\n* `language` *optional* - Sets the programming language mode to be used in the syntax highlighter.  The full list of supported languages can be found in the [Ace Editor Repository](https://github.com/ajaxorg/ace-builds/tree/master/src-min-noconflict).\n    * default: `html`\n* `theme` *optional* - Sets the Ace Editor Theme.  The full list of supported themes can be found in the [Ace Editor Repository](https://github.com/ajaxorg/ace/tree/master/lib/ace/theme).\n    * default: `chrome`\n* `readOnly` *optional* - If set to `true`, the editor will not be editable.\n    * default: `false`\n* `maxLines` *optional* - Sets the maximum number of lines that will be visible in the editor.\n    * default: 25\n\n#### Executed Code Attributes\n\nThe executed code displays in an iframe in order to preserve any items in the `\u003chead\u003e` that may be necessary for the example.\n* `height` *optional* - Sets the height of the iframe\n    * default: 300\n* `runStyle` *optional* - Sets the style of the iframe element\n    * default: `border:0`\n\n---\n# License\n\nMIT License\n\n\u0026copy; 2016 ZingChart, Inc.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzingchart%2Fgitbook-plugin-include-display-run","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzingchart%2Fgitbook-plugin-include-display-run","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzingchart%2Fgitbook-plugin-include-display-run/lists"}