docsify-plugin-meting-api/README.md

A docsify.js plugin for meting-api.

# docsify-plugin-meting-api
A [docsify.js](https://docsify.js.org) plugin for [meting-api](https://github.com/topics/meting).

## Install

1. Insert APlayer into **head** tag (index.html)

```html
    <!-- require APlayer -->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/aplayer/dist/APlayer.min.css">
    <script src="https://cdn.jsdelivr.net/npm/aplayer/dist/APlayer.min.js"></script>
```

2. Then insert docsify-plugin-meting-api plugin into **body** tag

```html
    <!-- docsify-plugin-meting-api -->
    <!-- required axios -->
    <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
    <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsify-plugin-meting-api/dist/docsify-plugin-meting-api.min.js"></script>
```

## Usage

You can set **MetingAPI** option, example:

```html
window.$docsify = {
    MetingAPI: {
        elementId: 'meting',
        api: 'https://api.i-meto.com/meting/api',
        fixed: true,
        autoplay: true,
        lrcType: 3,
        order: 'random',
        loop: 'all',
        mutex: true,
        theme: '#b7daff',
        playlists: [
            { server: 'netease', type: 'playlist', id: '7597958861' },
            { server: 'netease', type: 'playlist', id: '379025025' },
            { server: 'netease', type: 'playlist', id: '7383516738' },
        ],
    },
};
```

## Example

1. Run `npm i`
2. Run `npm run docs`
3. Go to [http://localhost:3000/](http://localhost:3000/)

## License

[MIT license](LICENSE)

## TODO

- ...