aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: c433ef9838fbbfa4136e9b32170185f8641ee580 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Embed codimd pads into Discourse for public.cat

This allows you to embed publi.cat pads into discourse.
It is a fork of [Librehost's version](https://lab.libreho.st/librehosters/embed-codimd.git) inspired by  https://github.com/fuerst/embed-etherpad-lite which embeds pads into posts using the Onebox mechanism.

# Usage

**This is meant to use with pads at <https://pad.public.cat>. You need to fork and adapt to your case.**

After installation just insert codimd links into your Discourse posts or comments. The pad 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://code.cepheide.org/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.example/pad-id` into HTML code like `<iframe src='http(s)://domain.example/pad-id'></iframe>`.