StyAndCo/zappyzep
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

More documentation work

Browse source
This commit is contained in:
Dragory 2019-08-22 02:58:32 +03:00
parent 5bbc318c68
commit 1681a45069
33 changed files with 286 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

7
dashboard/src/components/docs/CodeBlock.vue
View file

@ -1,16 +1,17 @@
<template>
<pre class="codeblock" v-highlightjs><code v-bind:class="lang" v-trim-code="trim"><slot></slot></code></pre>
<pre class="codeblock" v-highlightjs><code :class="lang" v-trim-code="trim"><slot></slot></code></pre>
</template>
<style scoped>
.codeblock {
padding: 0;
border-radius: 3px;
padding: 16px;
max-width: 970px; /* FIXME: temp fix for overflowing code blocks, look into properly later */
}
.hljs {
background: transparent;
padding: 16px;
padding: 0;
}
</style>

5
dashboard/src/components/docs/Layout.vue
View file

@ -105,8 +105,9 @@
}
.docs-sidebar-content {
position: sticky;
top: 20px;
/* can't scroll with a long list before reaching the end of the page, figure out */
/*position: sticky;*/
/*top: 20px;*/
}
.docs-sidebar .menu {

67
dashboard/src/components/docs/Plugin.vue
View file

@ -8,16 +8,28 @@
Name in config: <code>{{ data.name }}</code>
</p>
<div v-if="data.info.description">
<h2 class="z-title is-2 mt-2 mb-1">Description</h2>
<div class="content" v-html="renderMarkdown(data.info.description)"></div>
</div>
<div v-if="data.info.description" class="content" v-html="renderMarkdown(data.info.description)"></div>
<h2 class="z-title is-2 mt-2 mb-1">Default configuration</h2>
<p class="mt-1 mb-1">
To enable this plugin with default configuration, add <code>{{ data.name }}: {}</code> to the <code>plugins</code> list in config
</p>
<h2 id="default-configuration" class="z-title is-2 mt-2 mb-1">Default configuration</h2>
<CodeBlock lang="yaml">{{ renderConfiguration(data.options) }}</CodeBlock>
<b-collapse :open="false" class="card mt-1 mb-1">
<div slot="trigger" slot-scope="props" class="card-header" role="button">
<p class="card-header-title">Config schema</p>
<a class="card-header-icon">
<b-icon :icon="props.open ? 'menu-down' : 'menu-up'"></b-icon>
</a>
</div>
<div class="card-content">
<CodeBlock lang="plain">{{ data.configSchema }}</CodeBlock>
</div>
</b-collapse>
<div v-if="data.commands.length">
<h2 class="z-title is-2 mt-2 mb-1">Commands</h2>
<h2 id="commands" class="z-title is-2 mt-2 mb-1">Commands</h2>
<div v-for="command in data.commands">
<h3 class="z-title is-3 mt-2 mb-1">!{{ command.trigger }}</h3>
<div v-if="command.config.requiredPermission">
@ -30,6 +42,40 @@
Shortcut:
<code style="margin-right: 4px" v-for="alias in command.config.aliases">!{{ alias }}</code>
</div>
<div v-if="command.config.info && command.config.info.description" class="content mt-1 mb-1" v-html="renderMarkdown(command.config.info.description)"></div>
<b-collapse :open="false" class="card mt-1 mb-1">
<div slot="trigger" slot-scope="props" class="card-header" role="button">
<p class="card-header-title">Additional information</p>
<a class="card-header-icon">
<b-icon :icon="props.open ? 'menu-down' : 'menu-up'"></b-icon>
</a>
</div>
<div class="card-content">
Signatures:
<ul class="z-list z-ul">
<li>
<code>
!{{ command.trigger }}
<span v-for="param in command.parameters">{{ renderParameter(param) }} </span>
</code>
</li>
</ul>
<div class="mt-2" v-if="command.parameters.length">
Command arguments:
<ul class="z-list z-ul">
<li v-for="param in command.parameters">
<code>{{ renderParameter(param) }}</code>
<router-link :to="'/docs/descriptions/argument-types#' + (param.type || 'string')">{{ param.type || 'string' }}</router-link>
<div v-if="command.config.info && command.config.info.parameterDescriptions && command.config.info.parameterDescriptions[param.name]" class="content">
{{ renderMarkdown(command.config.info.parameterDescriptions[param.name]) }}
</div>
</li>
</ul>
</div>
</div>
</b-collapse>
</div>
</div>
</div>
@ -59,6 +105,15 @@
[this.pluginName]: options,
});
},
renderParameter(param) {
let str = `${param.name}`;
if (param.rest) str += '...';
if (param.required) {
return `<${str}>`;
} else {
return `[${str}]`;
}
},
},
data() {
return {