mirror of
https://github.com/PluralKit/PluralKit.git
synced 2026-02-08 14:57:54 +00:00
59 lines
No EOL
1.8 KiB
Vue
59 lines
No EOL
1.8 KiB
Vue
<template>
|
|
<div class="cmd-info">
|
|
<h3 :id="cmd">
|
|
<a class="header-anchor" :href="'#' + cmd">#</a>
|
|
{{ command.title }}
|
|
</h3>
|
|
<p class="summary">{{ command.summary }}</p>
|
|
|
|
<slot></slot>
|
|
|
|
<h4>Syntax <small>(how the command is used)</small></h4>
|
|
<CmdGroup>
|
|
<Cmd v-for="usage in command.usage" :comment="usage.desc" :usage="usage.cmd || usage" />
|
|
</CmdGroup>
|
|
|
|
<h4 v-if="command.examples">Examples</h4>
|
|
<CmdGroup v-if="command.examples">
|
|
<Cmd v-for="example in command.examples" :comment="example.desc" :usage="example.cmd || example" />
|
|
</CmdGroup>
|
|
|
|
<h4 v-if="command.arguments">Arguments <small>(fill in above)</small></h4>
|
|
<div class="info-arg" v-for="(arg, key) in command.arguments">
|
|
<Arg>{{ key }}</Arg>
|
|
(<span v-if="arg.type === 'string'">text</span><span v-if="arg.type === 'system'">system
|
|
reference</span><span v-if="arg.optional">, <em>optional</em></span>) - {{ arg.desc }}.
|
|
</div>
|
|
|
|
<h4 v-if="command.flags">Flags <small>(all optional, starts with a hyphen, place anywhere in the
|
|
command)</small></h4>
|
|
<div class="info-flag" v-for="(flag, key) in command.flags">
|
|
<Arg>-{{ key }}</Arg>
|
|
- {{ flag.desc }}
|
|
</div>
|
|
</div>
|
|
</template>
|
|
|
|
<script>
|
|
import commands from "../../../commands/commands";
|
|
|
|
export default {
|
|
props: ["cmd"],
|
|
|
|
data() {
|
|
return {command: commands[this.cmd]};
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<style lang="stylus">
|
|
.cmd-info {
|
|
.summary { margin-top: 0; }
|
|
h3, h4 { margin-bottom: 0.5rem; }
|
|
|
|
.info-arg, .info-flag {
|
|
line-height: 1.5;
|
|
margin: 0.5rem 0;
|
|
}
|
|
}
|
|
</style> |