Get Started

August 9, 2023 ยท View on GitHub

How to use in GitHub Markdown

template

[![Alt text](http://markdown-videos-api.jorgenkh.no/youtube/{video_id})](https://youtu.be/{video_id})

example

[![Pull Requests in 100 seconds](http://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4)](https://youtu.be/8lGpZkjnkt4)
Preview

Pull Requests in 100 seconds

How to use in HTML

template

<a href=https://youtu.be/{video_id}>
  <img src=http://markdown-videos-api.jorgenkh.no/youtube/{video_id} />
</a>

example

<a href=https://youtu.be/8lGpZkjnkt4>
  <img src=http://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4 />
</a>
Preview

<a href=https://youtu.be/8lGpZkjnkt4> <img src=http://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4 />


Documentation

For the full documentation see the Swagger and ReDoc docs

Optional parameters

NameData TypeDefault ValueDescriptionExampleAvailability
widthint320The width of the thumbnailhttp://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4?width=320All Endpoints
heightint180The height of the thumbnailhttp://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4?height=180All Endpoints
durationint500The duration you want to display each image in the gif (in milliseconds)http://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4.gif?duration=500Endpoints ending with .gif
filetypestrjpegValid filetypes are: jpeg, jpg, png, webp, bmp, gifhttp://markdown-videos-api.jorgenkh.no/youtube/8lGpZkjnkt4.gif?filetype=jpegAll still-image endpoints
urlstrhttps://youtu.be/dQw4w9WgXcQThe url of the video you want the thumbnail ofhttp://markdown-videos-api.jorgenkh.no/url?url=https%3A%2F%2Fyoutu.be%2FdQw4w9WgXcQ&width=320&height=180&filetype=jpeg/url

Examples with multiple parameters:

Contributing

Markdown Videos is still under development, please open an issue if you find any bugs, or if you want to suggest new features

Techstack

Made using Python's FastAPI

Hosted on Vercel

Local development

It is recommended that you follow the root README

Install pipenv if you haven't already

pip install --user pipenv

Install dependencies

pipenv install

Run Locally

pipenv dev # in development

# run the following in production environment
# pipenv start

ref: https://fastapi.tiangolo.com/#run-it

Running tests

For detailed instructions see the Fast API tutorial for Testing

pipenv test

ko-fi