Get markdown video meta

Get your video's metadata in the markdown or mdx file. Powered by remarkjs, fully typed.

What is it.

Normally, you will embed your video (Youtube) into markdown like this:

In markdown file with directive

::youtube{id=DXUAyRRkI6k}

or

::youtube{url=https://youtu.be/0DPZ9b9ZZr4}

Or you could use MDX to inject component into markdown syntax directly:

export const Youtube = ({ url }) => <iframe src={url} ...>Youtbue</iframe>;

<Youtube url="https://youtu.be/0DPZ9b9ZZr4" />

This tool utilize remark to find these url links and request video provider's api to get their metadata.

When should I use this.

One of the situation is encountering "Google could not determine the prominent video on the page". when Google try to index your video content on your website ¹. The solution of this issue is to create a dedicated page only for this video ². In order to do this, you can use this tool to help you retrieve video meta data and generate pages using the data.

How to use.

Install

npm install get-markdown-video-meta
yarn add get-markdown-video-meta
pnpm i get-markdown-video-meta

Dependencies

This tool relys on these dependencies, you have to install them:

npm install fast-glob remark remark-directive remark-frontmatter remark-mdx unist-util-visit
pnpm install fast-glob remark remark-directive remark-frontmatter remark-mdx unist-util-visit
yarn add fast-glob remark remark-directive remark-frontmatter remark-mdx unist-util-visit

Then you can import the named export of this tool.

import { getMarkdownVideoMeta } from "get-markdown-video-meta"

const meta = await getMarkdownVideoMeta({
  provider: "youtube",
  targets: ["/blog"],
  mdxComponents: [{ componentName: "Youtube", propName: "url" }],
});

Configuration

`provider`

type: youtube, vimeo (The returned meta will be empty array if you use vimeo)
required: true
description: The provider of your videos. Currently, we only support youtube and we will support vimeo in the future.

`targets`

type: Array of string
required: true
description: The target folder that your md/mdx files live. It can be multiple folders.
example: ["/blog"]

`mdxComponents`

type: array of { componentName: string; propName: "id" | "url" | "href"; }
required: either mdxComponents or directiveComponents exists
description: Array of mdxComponent that your mdx file is using
example: Take the mdx file below for example, the componentName will be Youtube and the propName will be url

---
title: youtube-blog-post-mdx
---

export const Youtube = ({ url }) => <div url={url}>Youtube</div>;

<Youtube url="https://youtu.be/0DPZ9b9ZZr4" />

`directiveComponents`

type: array of { directiveName: string; propName: "id" | "url" | "href"; }
required: either mdxComponents or directiveComponents exists
description: Array of directive that your md file is using
example: Take the md file below for example, the componentName will be youtube and the propName will be url

---
title: youtube-blog-post-directive
---

::youtube{id=DXUAyRRkI6k}

`googleApiKey`

type: string
required: false
description: If this key is in present, we will directly request Google API for much richer information of youtube videos. (Implementing)

`verbose`

type: boolean
required: false (default)
description: Display useful debug info

Response video meta

// Currrently, we only support simplified youtube meta coming from oembed api
export type SimpifiedYoutubeMeta = {
  title: string;
  author_name: string;
  author_url: string;
  thumbnail_height: number;
  thumbnail_width: number;
  thumbnail_url: string;
  html: string;
};

License

MIT

Useful links

Google rich results test

eiffelfly / get-markdown-video-meta Goto Github PK