aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2021-04-27 09:28:05 +0200
committerChocobozzz <me@florianbigard.com>2021-04-27 09:28:05 +0200
commit248875d243cdb868958c24a0c8031080628c57d7 (patch)
tree1513823f73c600dc5754ef4122836e3ea63f7d02
parent0c12054ae3c71b59b70cdd26fa68eea404a7daaa (diff)
downloadPeerTube-248875d243cdb868958c24a0c8031080628c57d7.tar.gz
PeerTube-248875d243cdb868958c24a0c8031080628c57d7.tar.zst
PeerTube-248875d243cdb868958c24a0c8031080628c57d7.zip
Fix plugins doc
-rw-r--r--support/doc/plugins/guide.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md
index 8d85092e7..53d53c26d 100644
--- a/support/doc/plugins/guide.md
+++ b/support/doc/plugins/guide.md
@@ -173,9 +173,18 @@ function register (...) {
173 registerSetting({ 173 registerSetting({
174 name: 'admin-name', 174 name: 'admin-name',
175 label: 'Admin name', 175 label: 'Admin name',
176
176 type: 'input', 177 type: 'input',
177 // type: input | input-checkbox | input-password | input-textarea | markdown-text | markdown-enhanced | 'select' | 'html' 178 // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html'
178 default: 'my super name' 179
180 // Optional
181 descriptionHTML: 'The purpose of this field is...',
182
183 default: 'my super name',
184
185 // If the setting is not private, anyone can view its value (client code included)
186 // If the setting is private, only server-side hooks can access it
187 private: false
179 }) 188 })
180 189
181 const adminName = await settingsManager.getSetting('admin-name') 190 const adminName = await settingsManager.getSetting('admin-name')