StyAndCo/zeppelin
3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-07-07 02:57:20 +00:00
Code Releases Activity

docs: plugin definition type

Browse source 
Signed-off-by: GitHub <noreply@github.com>
This commit is contained in:
Tiago R 2023-10-09 12:02:08 +00:00 • committed by GitHub
parent c428bb14de
commit 6548379369
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
backend/src/plugins/Tags/docs.ts
View file

@ -7,7 +7,7 @@ export function generateTemplateMarkdown(definitions: TemplateFunction[]): strin
const usage = def.signature ?? `(${def.arguments.join(", ")})`; const usage = def.signature ?? `(${def.arguments.join(", ")})`;
const examples = def.examples?.map((ex) => `> \`{${ex}}\``).join("\n") ?? null; const examples = def.examples?.map((ex) => `> \`{${ex}}\``).join("\n") ?? null;
return trimPluginDescription(` return trimPluginDescription(`
## ${def.name}${def.plugin ? ` (${def.plugin} only)` : ""} ## ${def.name}${def.plugin ? ` (${def.plugin})` : ""}
**${def.description}**\n **${def.description}**\n
__Usage__: \`{${def.name}${usage}}\`\n __Usage__: \`{${def.name}${usage}}\`\n
${examples ? `__Examples__:\n${examples}` : ""}\n\n ${examples ? `__Examples__:\n${examples}` : ""}\n\n