LamGC/wp-asciiplayer
1
0
Fork 0
mirror of https://github.com/LamGC/wp-asciiplayer.git synced 2025-06-30 20:37:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Add a Readme document for the adapter.

Browse Source
This commit is contained in:
LamGC
2023-06-05 13:50:16 +08:00
parent fba2455772
commit bd1895f79b
4 changed files with 71 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
asciiplayer/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
dist/
node_modules/

16
asciiplayer/README.md Normal file
View File

@ -0,0 +1,16 @@
# wp-asciiplayer-adapter
This library needs to be used with the WordPress Ascicast Player plugin.
## How to work
The Asciicast Player plugin will generate a div element containing the parameters required for asciicast playback for the asciiplayer short code in the post:
```html
<div class="asciiplayer-container"
data-ap-src="https://asciinema.org/a/28307.cast"
data-ap-opts="%7B%22fit%22%3A%22width%22%2C%22preload%22%3Atrue%7D">
</div>
```
Then, the adapter will search for these div elements and use [asciinema-player](https://www.npmjs.com/package/asciinema-player) to create an Asciicast player within the div elements.