Video to Markdown
Video to Markdown

How to embed a video in markdown? Here the answer. Add videos to your markdown files easier.

Video to Markdown

Test Cloudinary PayPal.me Sponsor

Netlify Status

Add videos to your markdown files easier starting from here!

Why?

How often did you find yourself googling ¨How to embed a video in markdown?¨

While 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.

Speaking HTMLese, this is what you would do:

<a href="{video-url}" title="Link Title"><img src="https://github.com/marcomontalbano/video-to-markdown/raw/main/{image-url}" alt="Alternate Text" /></a>

that translates into markdown as:

[![Alternate Text](https://github.com/marcomontalbano/video-to-markdown/raw/main/{image-url})]({video-url} "Link Title")

To speed up the process I developped this tool that will do it for you.

You just need to paste the video url in the field above and you will get the markdown you need.

Features

List of supported video providers:

A browser extension

Originally, this tool started as a simple website where you could paste a video URL and instantly get a nicely formatted Markdown snippet with the video thumbnail and title.

But over time, we ran into limitations: many websites restrict access to their content from external services, which made it harder to reliably fetch video metadata just from a pasted URL.

That’s why we moved to a browser extension.

By running directly in your browser, the extension can access video information from the page you’re currently viewing, with your permission. This makes the tool:

Just click the extension when you’re on a video page, and it will instantly generate the Markdown code for you — thumbnail included.

This change helps the service stay reliable, and super easy to use.

Hosting

First 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.

Now you can easily deploy your own copy on Netlify.

Deploy to Netlify

Development stuff

To run the project locally, here’s what you’ll need:

Requirements

Setup

cd into your local copy of the repository and run pnpm install

cd video-to-markdown
pnpm install
cp .env.sample .env
# update the .env with proper values
# build the extension
pnpm install -C extension
pnpm build:extension

# built extensions are available at:
# `./extension/dist-chrome.zip`
# `./extension/dist-firefox.zip`
pnpm dev

# http://localhost:8888

Privacy

Google Analytics is used to record the following:

All images are generated via Cloudinary and stored in it. In this way the generated images are cached so we can avoid to call Netlify functions again thus reducing the quota consumption.

By clicking on convert to markdown or consuming api you accept this terms & condition; no additional data is sent to the server.