Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Snailedlt/Markdown-Videos
Markdown Videos lets you embed videos into GitHub markdown with ease!
https://github.com/Snailedlt/Markdown-Videos
fastapi hacktoberfest markdown pillow pnpm pnpm-workspaces python python-3 rest-api sass svelte thumbnail-downloader tool turborepo typescript vercel vercel-deployment vercel-serverless-functions vimeo-thumbnail youtube-thumbnail
Last synced: 3 months ago
JSON representation
Markdown Videos lets you embed videos into GitHub markdown with ease!
- Host: GitHub
- URL: https://github.com/Snailedlt/Markdown-Videos
- Owner: Snailedlt
- License: mit
- Created: 2022-11-04T17:15:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T16:11:41.000Z (9 months ago)
- Last Synced: 2024-05-29T07:19:51.248Z (9 months ago)
- Topics: fastapi, hacktoberfest, markdown, pillow, pnpm, pnpm-workspaces, python, python-3, rest-api, sass, svelte, thumbnail-downloader, tool, turborepo, typescript, vercel, vercel-deployment, vercel-serverless-functions, vimeo-thumbnail, youtube-thumbnail
- Language: Python
- Homepage: https://markdown-videos.jorgenkh.no/
- Size: 1.03 MB
- Stars: 61
- Watchers: 1
- Forks: 11
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-fastapi - Markdown-Videos - API for generating thumbnails to embed into your markdown content. (Projects / Open Source Projects)
README
# Markdown Videos
[](https://wakatime.com/badge/github/Snailedlt/Markdown-Videos)
  
An open source [website](http://markdown-videos.jorgenkh.no/) and [API](http://markdown-videos-api.jorgenkh.no/) that adds a play button to a youtube video thumbnail, provided the video link or ID.
Markdown Videos lets you embed Youtube videos into GitHub markdown with ease!
## Showcase
||Preview|Info|
|--|--|--|
|Before|https://youtu.be/8lGpZkjnkt4|
- No Preview
- Redirects to video
|After|[](https://youtu.be/8lGpZkjnkt4)|
- Clearly shows it's a youtube video
- Play button and backdrop added
- Black bars removed
- Redirects to video
|After (GIF)|[](https://youtu.be/8lGpZkjnkt4.gif)|
- Clearly shows it's a youtube video
- Play button and backdrop added
- :sparkles: Animated GIF :sparkles:
- Redirects to video
## Supported video services
- [x] Youtube
- [x] Vimeo
---
## How to use?
The simplest way to use markdown-videos is to use [the website](http://markdown-videos.jorgenkh.no/). If you want to use the API, see the [API README](https://github.com/Snailedlt/Markdown-Videos/blob/main/apps/api/README.md) for more info
## Why choose Markdown-Videos?
| | |
|-|-|
| Excellent performance, trusted by over 100k users [(apparently)](https://www.apianalytics.dev/dashboard/fb1f330ea13b4f4c91a8de83895e56e3)! | [](https://www.apianalytics.dev/dashboard/fb1f330ea13b4f4c91a8de83895e56e3) |
| People when they see Markdown-Videos | [](https://imgur.com/gallery/1oi2Lth) |
## Contributing
Markdown Videos is still under development, please open an [issue](https://github.com/Snailedlt/Markdown-Videos/issues) if you find any bugs, or if you want to suggest new features.
Pull requests are also accepted and highly appreciated.
You can also contribute by [buying me a coffee on Ko-fi](https://ko-fi.com/H2H0GY0OU)
[](https://ko-fi.com/H2H0GY0OU)
If you want to contribute to the codebase, please read on.
## Local development
Wanna work only with the python or javascript stuff? check out [Additional info](#additional-info)
### Prerequisites
- [python](https://www.python.org/downloads/) 3.9 or higher
- [pipenv](https://pipenv.pypa.io/en/latest/)
- [pnpm](https://pnpm.io/installation)
- [node](https://nodejs.org/en) 18 or higher
I also highly recommend using [VS Code](https://code.visualstudio.com/) for local development, and installing the workspace's [recommended extensions](https://code.visualstudio.com/docs/editor/extension-marketplace#_recommended-extensions).
### install, run, build, etc...
install dependencies
```sh
pnpm install # installs web dependencies
pnpm api:install # installs api dependencies
```
create a new .env file from the .env.example
```sh
cp .env.example .env
```
run the api and website
```sh
pnpm dev
```
If you make changes make sure to run linting and testing before opening a PR
```sh
pnpm lint
pnpm test
```
## Additional info
In case you want more documentation on either the website or the api.
The API is built with Python, FastAPI, Pillow and Pipenv
- [API README](https://github.com/Snailedlt/Markdown-Videos/blob/main/apps/api/README.md)
The website is built with Svelte, Vite, Typescript, SCSS and pnpm
- [Website README](https://github.com/Snailedlt/Markdown-Videos/blob/main/apps/web/README.md)