{"id":30913901,"url":"https://github.com/aeskildsen/mkdocs-wavesurfer","last_synced_at":"2026-05-09T02:33:28.992Z","repository":{"id":304515275,"uuid":"1018159135","full_name":"aeskildsen/mkdocs-wavesurfer","owner":"aeskildsen","description":"mkdocs plugin for wavesurfer.js","archived":false,"fork":false,"pushed_at":"2025-08-27T06:17:03.000Z","size":47,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-25T08:23:24.822Z","etag":null,"topics":["markdown","mkdocs","mkdocs-material","wavesurfer-js"],"latest_commit_sha":null,"homepage":"","language":"Python","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/aeskildsen.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,"zenodo":null}},"created_at":"2025-07-11T17:54:25.000Z","updated_at":"2025-08-27T06:17:06.000Z","dependencies_parsed_at":"2025-07-13T16:32:37.967Z","dependency_job_id":"3191654f-3be4-49d6-bd4e-c20f53b7eaf4","html_url":"https://github.com/aeskildsen/mkdocs-wavesurfer","commit_stats":null,"previous_names":["aeskildsen/mkdocs-wavesurfer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aeskildsen/mkdocs-wavesurfer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeskildsen%2Fmkdocs-wavesurfer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeskildsen%2Fmkdocs-wavesurfer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeskildsen%2Fmkdocs-wavesurfer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeskildsen%2Fmkdocs-wavesurfer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aeskildsen","download_url":"https://codeload.github.com/aeskildsen/mkdocs-wavesurfer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeskildsen%2Fmkdocs-wavesurfer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32804943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["markdown","mkdocs","mkdocs-material","wavesurfer-js"],"created_at":"2025-09-09T23:01:13.467Z","updated_at":"2026-05-09T02:33:28.986Z","avatar_url":"https://github.com/aeskildsen.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-wavesurfer\n\nThis is a plugin for [mkdocs](https://www.mkdocs.org/) that adds a waveform display for `\u003caudio\u003e` elements using [wavesurfer.js](https://wavesurfer.xyz/).\n\nThis plugin only works when [mkdocs-audiotag](https://github.com/aeskildsen/mkdocs-audiotag) is also installed and enabled.\n\n![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-wavesurfer?color=darkgreen)\n\n## Quick start\n\n### Install the plugin\n\n```shell\npip install mkdocs-wavesurfer\n```\n\n### Enable the plugin in mkdocs.yml\n\n```yaml\nplugins:\n  - mkdocs-audiotag # required\n  - mkdocs-wavesurfer\n```\n\n### Embed an audio file in markdown source\n\nAs described on the [mkdocs-audiotag readme](https://github.com/aeskildsen/mkdocs-audiotag).\n\n```markdown\n![audio/ogg](my-audio-file.ogg)\n```\n\nThe waveform will be shown below the audio element's controls.\n\n## Configuration\n\nYou can tweak how *wavesurfer.js* displays the waveform using a range of configuration options. See the [wavesurfer.js documentation](https://wavesurfer.xyz/docs/types/wavesurfer.WaveSurferOptions) and the very nice [visual examples](https://wavesurfer.xyz/examples/?all-options.js) for a full description.\n\nAdd your options under the `mkdocs-wavesurfer` plugin in your `mkdocs.yml`.\n\n```yaml\nplugins:\n  - mkdocs-audiotag\n  - mkdocs-wavesurfer:\n      height: 200\n      wave_color: \"#0fcb2bff\"\n      progress_color: rgb(0, 100, 0)\n      cursor_color: red\n      cursor_width: 10\n      bar_width: 5\n      bar_gap: 2\n```\n\n![Waveform canvas generated with the configuration shown above](./waveform-wavesurfer.png)\n\nNote:\n\n- **Defaults:** You only need to specify the options you want to override, as others will use default values.\n- **Colors:** Can be specified as in CSS using hex values, rgb(), or color names, as shown in the example above.\n- **Case:** We use snake case in `mkdocs.yml` for consistency, as opposed to the wavesurfer.js docs which use javascript and camel case.\n\n### Use with mkdocs-material\n\nThe plugin can adapt to the color set by [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) for a visually coherent style.\n\n```yaml\nplugins:\n  - mkdocs-audiotag\n  - mkdocs-wavesurfer:\n      use_mkdocs-material_color: true\n```\n\nWhen this is enabled, the options `wave_color` and `progress_color` are overwritten, and the plugin will log a warning if they are present in `mkdocs.yml`.\n\n### Autopopulated options\n\nPlease note that the following wavesurfer options are populated automatically by the plugin and cannot be specified in the config:\n\n- `media_controls`\n- `media`\n- `url`\n- `container`\n\nIf you would like to remove the browser's default media controls, you can do so by configuring [mkdocs-audiotag](https://github.com/aeskildsen/mkdocs-audiotag):\n\n```yaml\nplugins:\n  - mkdocs-audiotag:\n      controls: false\n  - mkdocs-wavesurfer\n```\n\n### Default config values\n\nBelow are the default configuration values:\n\n```yaml\nplugins:\n  - mkdocs-wavesurfer:\n      height: 128\n      width: \"100%\"\n      split_channels: false\n      normalize: false\n      wave_color: \"#ff4e00\"\n      progress_color: \"#dd5e98\"\n      cursor_color: \"#ddd5e9\"\n      cursor_width: 2\n      bar_width: null\n      bar_gap: null\n      bar_radius: null\n      bar_height: null\n      bar_align: \"\"\n      min_px_per_sec: 1\n      fill_parent: true\n      autoplay: false\n      interact: true\n      drag_to_seek: false\n      hide_scrollbar: false\n      audio_rate: 1.0\n      auto_scroll: true\n      auto_center: true\n      sample_rate: 8000\n      use_mkdocs_material_color: false\n```\n\n## License\n\nThis plugin is licensed under the MIT license.\n\nBeware that [wavesurfer.js is licensed under the BSD-3-Clause license](https://github.com/katspaugh/wavesurfer.js?tab=BSD-3-Clause-1-ov-file).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeskildsen%2Fmkdocs-wavesurfer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faeskildsen%2Fmkdocs-wavesurfer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeskildsen%2Fmkdocs-wavesurfer/lists"}