etherpad-lite/doc/api/embed_parameters.md

49 lines
787 B
Markdown

# Embed parameters
You can easily embed your etherpad-lite into any webpage by using iframes. You can configure the embedded pad using embed paramters.
## Parameters
### showLineNumbers
* Boolean
Default: true
### showControls
* Boolean
Default: true
### showChat
* Boolean
Default: true
### useMonospaceFont
* Boolean
Default: false
### userName
* String
Default: "unnamed"
Example: `userName=Etherpad%20User`
### noColors
* Boolean
Default: false
### alwaysShowChat
* Boolean
Default: false
## Example
```
<iframe src='http://pad.test.de/p/PAD_NAME?showChat=false&showLineNumbers=false' width=600 height=400></iframe>
```
Cut and paste this into any webpage (between the body tags) to embed a pad. The above parameters will hide the chat and the line numbers.