3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-03-15 05:41:51 +00:00

More docs

This commit is contained in:
Dragory 2019-07-28 20:13:01 +03:00
parent b065b1b18e
commit 17f605dd6d
5 changed files with 91 additions and 2 deletions

View file

@ -16,5 +16,15 @@
All Zeppelin configuration is done through the dashboard by editing a YAML config file. By default, only the server
owner has access to this, but they can give other users access as they see fit. See <router-link to="/docs/configuration-format">Configuration format</router-link> for more details.
</p>
<h2>Plugins</h2>
<p>
Zeppelin is divided into plugins: grouped functionality that can be enabled/disabled as needed, and that have their own configurations.
</p>
<h2>Commands</h2>
<p>
The commands for each plugin are listed on the plugin's page (see "Plugins" on the menu). On these pages, the command prefix is assumed to be <code>!</code> but this can be changed on a per-server basis.
</p>
</div>
</template>

View file

@ -31,8 +31,7 @@
<p class="menu-label">Plugins</p>
<ul class="menu-list">
<li><a>Blah</a></li>
<li><a>Bloh</a></li>
<li><router-link to="/docs/plugins/mod-actions">Mod actions</router-link></li>
</ul>
</aside>
</div>

View file

@ -0,0 +1,3 @@
<template>
<router-view></router-view>
</template>

View file

@ -0,0 +1,67 @@
<template>
<div>
<h1>Mod actions</h1>
<p>
Name in config: <code>mod_actions</code>
</p>
<h2>Default configuration</h2>
<CodeBlock lang="yaml" trim="4">
config:
dm_on_warn: true
dm_on_kick: false
dm_on_ban: false
message_on_warn: false,
message_on_kick: false
message_on_ban: false
message_channel: null
warn_message: "You have received a warning on {guildName}: {reason}"
kick_message: "You have been kicked from {guildName}. Reason given: {reason}"
ban_message: "You have been banned from {guildName}. Reason given: {reason}"
alert_on_rejoin: false
alert_channel: null
can_note: false
can_warn: false
can_mute: false
can_kick: false
can_ban: false
can_view: false
can_addcase: false
can_massban: false
can_hidecase: false
can_act_as_other: false
overrides:
- level: ">=50"
config:
can_note: true
can_warn: true
can_mute: true
can_kick: true
can_ban: true
can_view: true
can_addcase: true
- level: ">=100"
config:
can_massban: true
can_hidecase: true
can_act_as_other: true
</CodeBlock>
<h2>Commands</h2>
<h3>!note</h3>
<p>
Permission: <code>can_note</code>
</p>
<p>
</p>
</div>
</template>
<script>
import CodeBlock from "../CodeBlock";
export default {
components: { CodeBlock },
};
</script>

View file

@ -35,6 +35,16 @@ export const router = new VueRouter({
path: "plugin-configuration",
component: () => import("./components/docs/PluginConfiguration.vue"),
},
{
path: "plugins",
component: () => import("./components/docs/plugins/Layout.vue"),
children: [
{
path: "mod-actions",
component: () => import("./components/docs/plugins/ModActions.vue"),
},
],
},
],
},