diff --git a/.gitignore b/.gitignore index d700cd9..b6222f1 100644 --- a/.gitignore +++ b/.gitignore @@ -47,6 +47,4 @@ wp-config.php # uncomment the next line #/wp-content/themes -.idea/ -node_modules/ -dist/ \ No newline at end of file +.idea/ \ No newline at end of file diff --git a/asciiplayer/.gitignore b/asciiplayer/.gitignore new file mode 100644 index 0000000..763301f --- /dev/null +++ b/asciiplayer/.gitignore @@ -0,0 +1,2 @@ +dist/ +node_modules/ \ No newline at end of file diff --git a/asciiplayer/README.md b/asciiplayer/README.md new file mode 100644 index 0000000..d96f517 --- /dev/null +++ b/asciiplayer/README.md @@ -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 +
+
+``` + +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. diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..15c07ee --- /dev/null +++ b/readme.txt @@ -0,0 +1,52 @@ +=== Asciicast Player === +Contributors: lamgc +Tags: asciicast, asciiplayer, asciinema +Requires at least: 5.2 +Tested up to: 6.2 +Stable tag: 0.1.0 +Requires PHP: 7.4 +License: GPLv3 +License URI: https://www.gnu.org/licenses/gpl-3.0.html + +Asciinema-Player for WordPress. + +== Description == + +This plugin helps you insert Asciicast files into the post, better presenting terminal operations to readers. + +## Quick start + +Add a shortcode to the post and enter the following: + +``` +[asciiplayer]https://asciinema.org/a/28307.cast[/asciiplayer] +``` + +The content of the shortcode is the URL of the ascicast file. + +### Options + +The AsciiPlayer shortcode supports the options supported by Asciinema-player, such as setting `fit` to `height` and closing the control bar: + +``` +[asciiplayer fit="height" controls="false"]https://asciinema.org/a/28307.cast[/asciiplayer] +``` + +You can find all available options [here](https://www.npmjs.com/package/asciinema-player#options). + +> Currently, only the `logger` option is not supported because it requires an object to be passed in. + +#### Style options + +For the convenience of customizing player elements, +the plugin has added an additional `style` **option**, +which corresponds to the `style` **attribute** of the player container element: + +``` +[asciiplayer style="width: 80%;"]https://asciinema.org/a/28307.cast[/asciiplayer] +``` + +== Changelog == + += 0.1.0 = +* The first available version.