{"id":16237524,"url":"https://github.com/vowstar/gitbook-plugin-wavedrom","last_synced_at":"2025-03-19T15:31:16.465Z","repository":{"id":138346288,"uuid":"124384820","full_name":"vowstar/gitbook-plugin-wavedrom","owner":"vowstar","description":"WaveDrom Plugin for GitBook and Honkit","archived":false,"fork":false,"pushed_at":"2024-10-28T13:51:54.000Z","size":587,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-28T19:38:28.600Z","etag":null,"topics":["gitbook","honkit","honkit-plugin","wavedrom"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vowstar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2018-03-08T11:57:45.000Z","updated_at":"2024-10-28T13:51:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"9763b192-a5d4-4639-ac83-c1cbf872c2c8","html_url":"https://github.com/vowstar/gitbook-plugin-wavedrom","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-wavedrom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-wavedrom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-wavedrom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vowstar%2Fgitbook-plugin-wavedrom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vowstar","download_url":"https://codeload.github.com/vowstar/gitbook-plugin-wavedrom/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243672456,"owners_count":20328766,"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":["gitbook","honkit","honkit-plugin","wavedrom"],"created_at":"2024-10-10T13:36:00.102Z","updated_at":"2025-03-19T15:31:16.458Z","avatar_url":"https://github.com/vowstar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gitbook-plugin-wavedrom\n\n[![Build Status](https://github.com/vowstar/gitbook-plugin-wavedrom/actions/workflows/test.yml/badge.svg)](https://github.com/vowstar/gitbook-plugin-wavedrom/actions)\n[![Coverage Status](https://coveralls.io/repos/github/vowstar/gitbook-plugin-wavedrom/badge.svg?branch=master)](https://coveralls.io/github/vowstar/gitbook-plugin-wavedrom?branch=master)\n[![NPM Version](https://img.shields.io/npm/v/gitbook-plugin-wavedrom.svg?style=flat)](https://www.npmjs.org/package/gitbook-plugin-wavedrom)\n[![NPM Downloads](https://img.shields.io/npm/dm/gitbook-plugin-wavedrom.svg?style=flat)](https://www.npmjs.org/package/gitbook-plugin-wavedrom)\n\n[WaveDrom](http://wavedrom.com/tutorial.html) Plugin for [~~GitBook~~](https://github.com/GitbookIO/gitbook) [Honkit](https://github.com/honkit/honkit)\n\nThis is a sample plugin for ~~GitBook~~ Honkit and is specially adapted for ~~GitBook~~ Honkit from [WaveDrom](http://wavedrom.com/tutorial.htm). ~~Gitbook~~ Honkit WaveDrom plugin is used to select from ``WaveDrom`` and converting it into a picture.\n\nWaveDrom is a JavaScript application. WaveJSON is a format that describes Digital Timing Diagrams. WaveDrom renders the diagrams directly inside the browser. Element \"signal\" is an array of WaveLanes. Each WaveLane has two mandatory fields: \"name\" and \"wave\".\n\n## Installation\n\n```bash\nnpm install gitbook-plugin-wavedrom\n```\n\nAdd this plugin into ``book.json``.\n\n```bash\n{\n  \"plugins\": [\"wavedrom\"]\n}\n```\n\n## Features\n\n* Support HTML, PDF, EPUB output(make sure your gitbook support SVG)\n* Support `` ```wavedrom `` code block quote\n* Multi code style support\n\n### Beautiful Waveform\n\n![Beautiful Waveform](https://raw.github.com/vowstar/gitbook-plugin-wavedrom/master/images/wavedrom.svg?sanitize=true)\n\n## Configuration\n\nbook.json add the wavedrom options\n\n```js\n\"pluginsConfig\": {\n  \"wavedrom\": {\n\n  }\n}\n```\n\n## Usage\n\nTo include a wavedrom waveform, just wrap your definition in a \"wavedrom\" code block. For example:\n\n\u003cpre lang=\"no-highlight\"\u003e\u003ccode\u003e```wavedrom\n{ signal: [\n  { name: \"pclk\", wave: 'p.......' },\n  { name: \"Pclk\", wave: 'P.......' },\n  { name: \"nclk\", wave: 'n.......' },\n  { name: \"Nclk\", wave: 'N.......' },\n  { name: 'clk0', wave: 'phnlPHNL' },\n  { name: 'clk1', wave: 'xhlhLHl.' },\n  { name: 'clk2', wave: 'hpHplnLn' },\n  { name: 'clk3', wave: 'nhNhplPl' },\n  { name: 'clk4', wave: 'xlh.L.Hx' },\n]}\n```\n\u003c/code\u003e\u003c/pre\u003e\n\nAlso you can put in your book block as\n\n```js\n{% wavedrom %}\n{ signal: [\n  { name: \"pclk\", wave: 'p.......' },\n  { name: \"Pclk\", wave: 'P.......' },\n  { name: \"nclk\", wave: 'n.......' },\n  { name: \"Nclk\", wave: 'N.......' },\n  { name: 'clk0', wave: 'phnlPHNL' },\n  { name: 'clk1', wave: 'xhlhLHl.' },\n  { name: 'clk2', wave: 'hpHplnLn' },\n  { name: 'clk3', wave: 'nhNhplPl' },\n  { name: 'clk4', wave: 'xlh.L.Hx' },\n]}\n{% endwavedrom %}\n```\n\nSet width and height parameter:\n\n```js\n{% wavedrom width=800, height=800 %}\n{ signal: [\n  { name: \"pclk\", wave: 'p.......' },\n  { name: \"Pclk\", wave: 'P.......' },\n  { name: \"nclk\", wave: 'n.......' },\n  { name: \"Nclk\", wave: 'N.......' },\n  {},\n  { name: 'clk0', wave: 'phnlPHNL' },\n  { name: 'clk1', wave: 'xhlhLHl.' },\n  { name: 'clk2', wave: 'hpHplnLn' },\n  { name: 'clk3', wave: 'nhNhplPl' },\n  { name: 'clk4', wave: 'xlh.L.Hx' },\n]}\n{% endwavedrom %}\n```\n\nOf course, you can also pass the parameters like this.\n\n\u003cpre\u003e\u003ccode\u003e```wavedrom {width=600,height=1000}\n{ signal: [\n  { name: \"pclk\", wave: 'p.......' },\n  { name: \"Pclk\", wave: 'P.......' },\n  { name: \"nclk\", wave: 'n.......' },\n  { name: \"Nclk\", wave: 'N.......' },\n  {},\n  { name: 'clk0', wave: 'phnlPHNL' },\n  { name: 'clk1', wave: 'xhlhLHl.' },\n  { name: 'clk2', wave: 'hpHplnLn' },\n  { name: 'clk3', wave: 'nhNhplPl' },\n  { name: 'clk4', wave: 'xlh.L.Hx' },\n]}\n```\n\u003c/code\u003e\u003c/pre\u003e\n\n\u003e If use both configure method, the code configure will overwrite the template configure.\n\n## Learn WaveDrom and more information\n\n[WaveDrom](http://wavedrom.com/tutorial.html)\n\n## Thanks\n\n* [@ly0](https://github.com/ly0)\n* [@0x00-pl](https://github.com/0x00-pl)\n* [@manageryzy](https://github.com/manageryzy)\n\n## See also\n\nThese plugins are also available on honkit.\n\n|                                    Plugin                                     |                      Description                       |\n| ----------------------------------------------------------------------------- | ------------------------------------------------------ |\n| [gitbook-plugin-uml](https://github.com/vowstar/gitbook-plugin-uml)           | A plug-in that use plantuml to draw beautiful pictures |\n| [gitbook-plugin-wavedrom](https://github.com/vowstar/gitbook-plugin-wavedrom) | A plug-in that can draw waveforms and register tables  |\n| [gitbook-plugin-sequence](https://github.com/vowstar/gitbook-plugin-sequence) | A plug-in that can draw sequence diagrams              |\n| [gitbook-plugin-flow](https://github.com/vowstar/gitbook-plugin-flow)         | A plug-in that can draw flowchart.js diagrams          |\n| [gitbook-plugin-echarts](https://github.com/vowstar/gitbook-plugin-echarts)   | A plug-in that can draw various charts such as bar/pie |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvowstar%2Fgitbook-plugin-wavedrom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvowstar%2Fgitbook-plugin-wavedrom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvowstar%2Fgitbook-plugin-wavedrom/lists"}