{"id":16358922,"url":"https://github.com/martignoni/hugo-video","last_synced_at":"2025-11-05T04:30:33.022Z","repository":{"id":43751683,"uuid":"214877744","full_name":"martignoni/hugo-video","owner":"martignoni","description":"A Hugo theme component to embed videos using HTML video element","archived":false,"fork":false,"pushed_at":"2024-08-19T13:48:24.000Z","size":54,"stargazers_count":113,"open_issues_count":5,"forks_count":28,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-11T09:36:12.628Z","etag":null,"topics":["hugo","hugo-theme-component","multilingual","video","video-embed"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/martignoni.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":"2019-10-13T19:07:41.000Z","updated_at":"2025-01-05T19:13:24.000Z","dependencies_parsed_at":"2023-02-04T07:16:20.822Z","dependency_job_id":"a95681fd-d103-4a81-8794-b07c7415bb44","html_url":"https://github.com/martignoni/hugo-video","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martignoni%2Fhugo-video","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martignoni%2Fhugo-video/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martignoni%2Fhugo-video/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martignoni%2Fhugo-video/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/martignoni","download_url":"https://codeload.github.com/martignoni/hugo-video/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239449590,"owners_count":19640535,"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":["hugo","hugo-theme-component","multilingual","video","video-embed"],"created_at":"2024-10-11T02:07:04.299Z","updated_at":"2025-11-05T04:30:32.983Z","avatar_url":"https://github.com/martignoni.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hugo-video\n\n\u003c!-- [![Awesome](https://awesome.re/badge.svg)](https://github.com/budparr/awesome-hugo) --\u003e\n\n## About\n\nThis [Hugo](https://gohugo.io) theme component provides a shortcode: `video` for embedding videos using the [HTML video element](https://devdocs.io/html/element/video).\n\nIt comes with English, French, German, Russian, Japanese, Korean, Polish, Chinese and Chinese (Taiwan) localizations. Other languages welcome! Send your pull request.\n\n## Features\n\nThis shortcode uses Hugo [Page Resources](https://gohugo.io/content-management/page-resources/). The video to display __must be placed in the [page bundle](https://gohugo.io/content-management/page-bundles/)__.\n\nThe shortcode takes one mandatory argument: the filename of the video file to display, __without the extension__. It detects automatically if several versions of the file exists in the page bundle, and add accordingly the multiple `src` tags. When an image file with the same filename is also present in the page bundle, it is automatically used as a poster frame.\n\nWhen the browser doesn't support the [HTML video element](https://devdocs.io/html/element/video), the shortcode displays a localized notice allowing the video download for local playing.\n\nFollowing video formats are supported:\n- MP4 (extension `.mp4` or `.m4v`)\n- WebM, (extension `.webm`)\n- Ogg, (extension `.ogv`)\n\nDefault values:\n- Browser's default controls are displayed (`controls` attribute is always included)\n- Video can be preloaded (`preload=\"auto\"` attribute is always included)\n- Video width is 100% (`width=\"100%\"` attribute is included); this can be changed by indicating the desired width when calling the shortcode, see example below)\n- Video height attribute is not set by default, but can be explicitly set by indicating the desired height in pixels (i.e. `height=\"640\"`); credit goes to Evgeny Kuznetsov for this feature\n- Following other video attributes can be set: `muted=\"true\"`, `autoplay=\"true\"` and `loop=\"true\"`. Credit goes to Tom McKenzie for this feature\n- Default settings are used for other video attributes\n\nWhen no video file of the given name is found in the supported format (see above), the shortcode __intentionally fails__ with a `No valid video file with filename \u003cfilename\u003e found.` error.\n\n## Usage\n\n1. Add the `hugo-video` as a submodule to be able to get upstream changes later\n    ```bash\n    git submodule add https://github.com/martignoni/hugo-video.git themes/hugo-video\n    ```\n2. Add `hugo-video` as the left-most element of the `theme` list variable in your site's or theme's configuration file `config.yaml` or `config.toml`. Example, with `config.yaml`:\n    ```yaml\n    theme: [\"hugo-video\", \"my-theme\"]\n    ```\n    or, with `config.toml`,\n    ```toml\n    theme = [\"hugo-video\", \"my-theme\"]\n    ```\n3. Place your video file(s) in the [page bundle](https://gohugo.io/content-management/page-bundles/) of your post.\n4. In your site, use the shortcode, this way, indicating the video filename __without its extension__. If your video file is `my-beautiful-screencast.mp4`, type this:\n    ```go\n    {{\u003c video src=\"my-beautiful-screencast\" \u003e}}\n    ```\n    or\n    ```go\n    {{\u003c video src=\"my-beautiful-screencast\" width=\"600px\" \u003e}}\n    ```\n\n### Acknowledgements\n\n#### Localization\n\nThanks to\n\n- [Arsenii Lyashenko](https://github.com/ark0f), for providing the Russian localization.\n- [Genji Fujimori](https://github.com/ahandsel), for providing the Japanese localization.\n- [Junho Park](https://github.com/cnaa97), for providing the Korean localization.\n- [Dominik Palula](https://github.com/D00NIK), for providing the Polish localization.\n- [hst1189](https://github.com/hst1189), for providing the Chinese and Chinese (Taiwan) localizations.\n\n#### Developement\n\nThanks to\n\n- [Tom McKenzie](https://github.com/grrowl), for implementing `muted`, `autoplay` and `loop` video attributes support.\n- [Olaf Haag](https://github.com/OlafHaag), [Paul Lettington](https://github.com/plett) and [Christian Mahnke](https://github.com/cmahnke), for raising and fixing a few bugs.\n- [Arsenii Lyashenko](https://github.com/ark0f), for implementing `controls` disabling option.\n- [Evgeny Kuznetsov](https://github.com/nekr0z), for implementing `height` optional attribute.\n\n### Licence\n\nCopyright © 2019 onwards, Nicolas Martignoni nicolas@martignoni.net.\n\nAll the source code is licensed under GPL 3 or any later version\n\nThis program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartignoni%2Fhugo-video","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmartignoni%2Fhugo-video","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartignoni%2Fhugo-video/lists"}