Skip to content
This repository has been archived by the owner on Jan 4, 2024. It is now read-only.

Commit

Permalink
docs: add contents and examples sections
Browse files Browse the repository at this point in the history
  • Loading branch information
soulless-viewer authored Feb 7, 2023
1 parent 8f5b6e4 commit 7de21ad
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

This plugin allows you to embed videos on the documentation pages using a simple Markdown syntax.

## Contents

* [Installation](#installation)
* [Usage](#usage)
* [Configuration](#configuration)
* [Marker](#marker)
* [Style](#style)
* [Tag `<video>`](#tag-video)
* [Video type](#video-type)
* [Video autoplay](#video-autoplay)
* [Video loop](#video-loop)
* [Video muted](#video-muted)
* [Video controls](#video-controls)
* [Embedding examples](#embedding-examples)

## Installation

Install the package with pip:
Expand Down Expand Up @@ -186,6 +201,23 @@ plugins:

> The operation of this parameter may be affected by browser settings or video provider configuration

## Embedding examples

The following list contains some of the popular services, as well as examples of direct and embedded links to their videos.

* YouTube
* https://www.youtube.com/watch?v=iSpglxHTJVM
* https://www.youtube.com/embed/iSpglxHTJVM
* Vimeo
* https://vimeo.com/224903454
* https://player.vimeo.com/video/224903454
* Dailymotion
* https://www.dailymotion.com/video/x7ogfqo
* https://www.dailymotion.com/embed/video/x7ogfqo
* Facebook Watch
* https://www.facebook.com/gamechangersmovie/videos/343098689705587
* https://www.facebook.com/plugins/video.php?href=https://www.facebook.com/gamechangersmovie/videos/343098689705587

## Contributing

1. Fork it.
Expand Down

0 comments on commit 7de21ad

Please sign in to comment.