mirror of
https://github.com/ZeppelinBot/Zeppelin.git
synced 2025-03-15 05:41:51 +00:00
improve docs
Signed-off-by: GitHub <noreply@github.com>
This commit is contained in:
parent
77f414925f
commit
e1996e35f6
1 changed files with 1 additions and 1 deletions
|
@ -7,7 +7,7 @@ export function generateTemplateMarkdown(definitions: TemplateFunction[]): strin
|
|||
const usage = def.signature ?? `(${def.arguments.join(", ")})`;
|
||||
const examples = def.examples?.map((ex) => `> \`{${ex}}\``).join("\n") ?? null;
|
||||
return trimPluginDescription(`
|
||||
## ${def.name}
|
||||
## ${def.name}${def.plugin ? ` (${def.plugin} only)` : ""}
|
||||
**${def.description}**\n
|
||||
__Usage__: \`{${def.name}${usage}}\`\n
|
||||
${examples ? `__Examples__:\n${examples}` : ""}\n\n
|
||||
|
|
Loading…
Add table
Reference in a new issue