{"id":13616205,"url":"https://github.com/marcomontalbano/video-to-markdown","last_synced_at":"2025-04-09T15:00:22.672Z","repository":{"id":37552068,"uuid":"147711376","full_name":"marcomontalbano/video-to-markdown","owner":"marcomontalbano","description":"How to embed a video in markdown? Here the answer. Add videos to your markdown files easier.","archived":false,"fork":false,"pushed_at":"2025-03-20T21:30:31.000Z","size":6986,"stargazers_count":211,"open_issues_count":5,"forks_count":25,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T14:00:54.276Z","etag":null,"topics":["asciinema","cleanshot","cloudinary","dailymotion","facebook","google-drive","loom","markdown","netlify","netlify-lambda","onedrive","parcel","peertube","streamable","tiktok","travis-ci","video","vimeo","wistia","youtube"],"latest_commit_sha":null,"homepage":"https://video-to-markdown.marcomontalbano.com","language":"TypeScript","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/marcomontalbano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"marcomontalbano"}},"created_at":"2018-09-06T17:46:43.000Z","updated_at":"2025-04-02T12:12:53.000Z","dependencies_parsed_at":"2024-01-17T00:18:47.694Z","dependency_job_id":"12795e5f-3a83-4b93-ab10-19918cec412e","html_url":"https://github.com/marcomontalbano/video-to-markdown","commit_stats":{"total_commits":139,"total_committers":2,"mean_commits":69.5,"dds":0.09352517985611508,"last_synced_commit":"f9944dd683ee8b8b93fb706d4fb8bd358daab7fe"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcomontalbano%2Fvideo-to-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcomontalbano%2Fvideo-to-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcomontalbano%2Fvideo-to-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcomontalbano%2Fvideo-to-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcomontalbano","download_url":"https://codeload.github.com/marcomontalbano/video-to-markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248055272,"owners_count":21040153,"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":["asciinema","cleanshot","cloudinary","dailymotion","facebook","google-drive","loom","markdown","netlify","netlify-lambda","onedrive","parcel","peertube","streamable","tiktok","travis-ci","video","vimeo","wistia","youtube"],"created_at":"2024-08-01T20:01:25.083Z","updated_at":"2025-04-09T15:00:22.634Z","avatar_url":"https://github.com/marcomontalbano.png","language":"TypeScript","funding_links":["https://github.com/sponsors/marcomontalbano","https://www.paypal.me/marcomontalbano"],"categories":["TypeScript"],"sub_categories":[],"readme":"Video to Markdown\n=================\n\n[![Test](https://github.com/marcomontalbano/video-to-markdown/actions/workflows/test.yaml/badge.svg)](https://github.com/marcomontalbano/video-to-markdown/actions/workflows/test.yaml)\n[![Cloudinary](https://shields.io/badge/-Cloudinary-3448c5)](https://cloudinary.com/invites/lpov9zyyucivvxsnalc5/nfvt85kdqleszdah0hxq?t=default)\n[![PayPal.me](https://img.shields.io/badge/paypal-donate-119fde.svg)](https://www.paypal.me/marcomontalbano)\n[![Sponsor](https://img.shields.io/badge/-Sponsor-fafbfc?logo=GitHub%20Sponsors)](https://github.com/sponsors/marcomontalbano)\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/545bbce5-8f34-4834-9e16-685a9990c987/deploy-status)](https://app.netlify.com/sites/video-to-markdown/deploys)\n\nAdd videos to your markdown files easier [starting from here](https://video-to-markdown.marcomontalbano.com/)!\n\n\n## Why?\n\nHow often did you find yourself googling _¨How to embed a video in markdown?¨_\n\nWhile its not possible to embed a video in markdown, the best and easiest way is to extract a frame from the video, add a layer with a play icon and link the video url on the image.\n\nSpeaking HTMLese, this is what you would do:\n\n```html\n\u003ca href=\"{video-url}\" title=\"Link Title\"\u003e\u003cimg src=\"{image-url}\" alt=\"Alternate Text\" /\u003e\u003c/a\u003e\n```\n\nthat translates into markdown as:\n\n```md\n[![Alternate Text]({image-url})]({video-url} \"Link Title\")\n```\n\nTo speed up the process I developped this tool that will do it for you.\n\nYou just need to paste the video url in the field above and you will get the markdown you need.\n\n\n## Features\n\nList of supported video providers:\n\n- [x] Asciinema\n- [x] CleanShot Cloud\n- [x] Dailymotion\n- [x] Facebook (low-quality)\n- [x] Google Drive\n- [x] Imgur\n- [x] Loom\n- [x] OneDrive\n- [x] PeerTube\n- [x] Streamable\n- [x] TikTok\n- [x] Vimeo\n- [x] Wistia\n- [x] Youtube\n\n\n## Hosting\n\nFirst of all you need to create a [Cloudinary] account (I'm using this service to generate and host images) so that you can copy your personal `CLOUDINARY_URL` from your dashboard. The url is something similar to `cloudinary://my_key:my_secret@my_cloud_name`.\n\nNow you can easily deploy your own copy on Netlify.\n\n[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/marcomontalbano/video-to-markdown)\n\n\n## Development stuff\n\nTo run the project locally, here’s what you’ll need:\n\n### Requirements\n\n* [Cloudinary] account\n* [Node.js](https://nodejs.org/) 22.14 or greater\n\n### Setup\n\n`cd` into your local copy of the repository and run `pnpm install`\n\n```sh\ncd video-to-markdown\npnpm install\n```\n\n```sh\ncp .env.sample .env\n# update the .env with proper values\n```\n\n* `CLOUDINARY_URL` ( **required** ) - this is the `API Environment variable` that you can get from your Cloudinary dashboard inside the **Account Details** section.\n* `GA_TRACKING_ID` ( _optional_ ) - this is a Google Analytics Tracking ID. Can be used if you need to track page views and events.\n* `NETLIFY_ACCESS_TOKEN` ( _optional_ ) - this a Netlify Access Token. In combination with the `SITE_ID` can be used to display the **API Usage** in the website.\n* `SITE_ID` ( _optional_ ) - this the Netlify Site ID. In combination with the `NETLIFY_ACCESS_TOKEN` can be used to display the **API Usage** in the website.\n* `USE_HIGH_QUALITY` ( _optional_ ) - this is a boolean flag. If `true`, the generated images will be stored in Contenful with hi-res quality (default to `false`)\n\n```sh\npnpm dev\n\n# http://localhost:8888\n```\n\n## Privacy\n\nGoogle Analytics is used to record the following:\n\n* [Basic visit data](https://support.google.com/analytics/answer/6004245?ref_topic=2919631).\n* `referer` or `video url` to track api usage.\n\nAll images are generated via [Cloudinary] and stored in it.\nIn this way the generated images are cached so we can avoid to call Netlify functions again thus reducing the quota consumption.\n\nBy clicking on `convert to markdown` or consuming api you accept this terms \u0026 condition; no additional data is sent to the server.\n\n[Cloudinary]: https://cloudinary.com/invites/lpov9zyyucivvxsnalc5/nfvt85kdqleszdah0hxq?t=default\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcomontalbano%2Fvideo-to-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcomontalbano%2Fvideo-to-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcomontalbano%2Fvideo-to-markdown/lists"}