Add videos to your markdown files easier.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.env.sample
.gitignore
.nvmrc
.posthtmlrc.js
.sassrc.js
.travis.yml
LICENSE
README.md
netlify.toml
package.json
webpack.client.js
webpack.server.js
yarn.lock

README.md

Video to Markdown

Build Status

Add videos to your markdown files easier - https://video-to-markdown.netlify.com.

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="{image-url}" alt="Alternate Text" /></a>

that translates into markdown as:

[![Alternate Text]({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:

  • Youtube
  • Dailymotion
  • Vimeo

Hosting

If you want your own copy, just

Deploy to Netlify

Development stuff

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

System Requirements

Setup

cd into your local copy of the repository and run yarn

cd video-to-markdown
yarn
yarn start

This will start the client server on http://localhost:8080, and the netlify-lambda server on http://localhost:9000.

netlify-lambda isn’t required to deploy Lambda functions to Netlify, but it offers some handy features out of the box that make it quicker to get started, like the local dev server and nice defaults for transpiling and bundling functions in production.

The client server is configured to proxy /.netlify requests to the Lambda server (see webpack.client.js). This is the same behavior the site has when it’s deployed to Netlify.