zappyzep/dashboard/src/components/docs/Introduction.vue
2020-12-13 22:11:04 +02:00

44 lines
1.5 KiB
Vue

<template>
<div>
<h1>Introduction</h1>
<p>
Zeppelin is a private moderation bot for Discord, designed with large servers and reliability in mind.
</p>
<!-- WIP bar -->
<div class="px-3 py-2 rounded bg-gray-800 shadow-md inline-block">
<alert class="inline-icon mr-1 text-yellow-300" />
This documentation is a work in progress.
</div>
<h2>Getting the bot</h2>
<p>
Since the bot is currently private, access to the bot is granted on a case by case basis.<br>
There are plans to streamline this process in the future.
</p>
<h2>Configuration</h2>
<p>
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/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>
<script lang="ts">
import Alert from 'vue-material-design-icons/Alert.vue';
export default {
components: { Alert },
};
</script>