mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-04-20 07:35:05 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 27

Add docs.

Browse source
This commit is contained in:
Marcel Klehr 2012-08-03 22:04:06 +02:00
parent aa986ab954
commit 5fac05a395
6 changed files with 768 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

49
doc/api/embed_parameters.md Normal file
View file

@ -0,0 +1,49 @@
# 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.