diff options
author | realitygaps <realitygaps@weho.st> | 2018-11-12 20:23:18 +0100 |
---|---|---|
committer | realitygaps <realitygaps@weho.st> | 2018-11-12 20:23:18 +0100 |
commit | f96eb3440b6f0af0524197210c49de0e45775adf (patch) | |
tree | 700af6982ba7441936bdb92a6a8e68c657282d7f /README.md | |
download | discourse-pad-f96eb3440b6f0af0524197210c49de0e45775adf.tar.gz |
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3393d4 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Embed codimd pads into Discourse for libreho.st + +This allows you to embed libreho.st pads into discourse. Its based on https://github.com/fuerst/embed-etherpad-lite which embeds pads into posts using the Onebox mechanism. + +# Usage + +After installation just insert codimd links into your Discourse posts or comments. The Etherpad will be embedded using the famous and beloved [IFRAME](https://en.wikipedia.org/wiki/HTML_element#Frames) tag and is fully operational. + +# Installation + +Read [Install a Plugin](https://meta.discourse.org/t/install-a-plugin/19157) at meta.discourse.org. + +The configuration line you have to add to your container's app.yml file looks like: + +``` +- git clone https://lab.libreho.st/librehosters/embed-codimd.git +``` + +# Details + +The plugin uses the ["Brand new plugin interface"](https://meta.discourse.org/t/brand-new-plugin-interface/8793/88) to change URL's like `http(s)://domain.tld/pad-id` into HTML code like `<iframe src='http(s)://domain.tld/pad-id'></iframe>`. + |