Skip to content

Latest commit

 

History

History
69 lines (46 loc) · 2.58 KB

README.md

File metadata and controls

69 lines (46 loc) · 2.58 KB

GitHub forks GitHub watchers GitHub repo size GitHub License

Docsify Custom YouTube Embed Plugin

I recommend reading through Docsify Preview

This plugin enhances Docsify with advanced YouTube video embedding capabilities, allowing for easy insertion of responsive, customizable YouTube videos directly into your Markdown files.

The detailed explanation of the plugin usage and its preview is shown in this 🔗 Docsify documentation.


Features

  1. Simple Embed Syntax
  2. Customizable Dimensions
  3. Flexible Alignment
  4. Responsive Design

This repository has two ways of embedding YouTube videos

  • yt-embed: will only embed a YouTube video with customizable size and alignment.
  • yt-embed-collapse can enclose a YouTube video within a collapsible element.

Customization

You can adjust the maximum width, box shadow, and border radius of the video containers by modifying the CSS provided with the plugin.


Compatibility

This plugin is designed to work with Docsify and has been tested with the latest version as of July/2024. It should be compatible with most modern web browsers.


Contributing

Contributions, issues, and feature requests are welcome! Feel free to check issues page.


License

Copyright 2024 Sanjay0302

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.