mirror of
https://github.com/PluralKit/PluralKit.git
synced 2026-02-13 09:10:14 +00:00
Initial docs rewrite using Vuepress
This commit is contained in:
parent
e7191def02
commit
2b259869a0
47 changed files with 8276 additions and 1397 deletions
47
docs/content/.vuepress/components/Arg.vue
Normal file
47
docs/content/.vuepress/components/Arg.vue
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
<template>
|
||||
<div class="command-argument-parent">
|
||||
<div class="command-argument">
|
||||
<slot />
|
||||
</div>
|
||||
|
||||
<div v-if="false" class="argument-details">
|
||||
{{ name }}
|
||||
<span v-if="optional !== undefined">(optional)</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</template>
|
||||
|
||||
<style lang="stylus">
|
||||
.command-argument-parent {
|
||||
display: inline-flex;
|
||||
flex-direction: column;
|
||||
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.command-argument {
|
||||
padding: 0 0.5rem;
|
||||
background-color: lighten($exampleBgColor, 15%);
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.argument-details {
|
||||
font-size: 0.75em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.arg-input {
|
||||
/*font-size: 0.9rem;*/
|
||||
color: $exampleTextColor;
|
||||
background-color: transparent;
|
||||
text-align: center;
|
||||
border: none;
|
||||
}
|
||||
</style>
|
||||
|
||||
<script>
|
||||
export default {
|
||||
props: ["optional", "name", "edit", "value"],
|
||||
}
|
||||
</script>
|
||||
23
docs/content/.vuepress/components/Cmd.vue
Normal file
23
docs/content/.vuepress/components/Cmd.vue
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
<template>
|
||||
<p class="command-example">
|
||||
<span class="bot-prefix">pk;</span><slot></slot>
|
||||
</p>
|
||||
</template>
|
||||
|
||||
<style lang="stylus">
|
||||
.command-example {
|
||||
font-size: $exampleFontSize;
|
||||
font-family: $exampleFontFamily;
|
||||
|
||||
color: $exampleTextColor;
|
||||
background-color: $exampleBgColor;
|
||||
border-radius: 6px;
|
||||
|
||||
margin: 0.5rem 0;
|
||||
padding: 0.75rem 1.25rem;
|
||||
}
|
||||
|
||||
.bot-prefix {
|
||||
color: $examplePrefixColor;
|
||||
}
|
||||
</style>
|
||||
23
docs/content/.vuepress/components/CmdGroup.vue
Normal file
23
docs/content/.vuepress/components/CmdGroup.vue
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
<template>
|
||||
<div class="command-example-group">
|
||||
<slot />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style lang="stylus">
|
||||
.command-example-group {
|
||||
background-color: $exampleBgColor;
|
||||
border-radius: 6px;
|
||||
|
||||
padding: 0.75rem 1.25rem;
|
||||
}
|
||||
|
||||
.command-example-group .command-example {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.command-example-group .command-example:not(:last-child) {
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
</style>
|
||||
19
docs/content/.vuepress/components/CmdInline.vue
Normal file
19
docs/content/.vuepress/components/CmdInline.vue
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
<template>
|
||||
<span class="example-inline"><span class="inline-bot-prefix">pk;</span><slot /></span>
|
||||
</template>
|
||||
|
||||
<style lang="stylus">
|
||||
.example-inline {
|
||||
font-size: $exampleFontSize;
|
||||
font-family: $exampleFontFamily;
|
||||
|
||||
background-color: $exampleBgColor;
|
||||
color: $exampleTextColor;
|
||||
padding: 0.2rem 0.4rem;
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
.inline-bot-prefix {
|
||||
color: $examplePrefixColor;
|
||||
}
|
||||
</style>
|
||||
54
docs/content/.vuepress/config.js
Normal file
54
docs/content/.vuepress/config.js
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
module.exports = {
|
||||
title: "PluralKit",
|
||||
|
||||
base: "/",
|
||||
head: [
|
||||
["link", { rel: "icon", type: "image/png", href: "/favicon.png" }],
|
||||
],
|
||||
evergreen: true,
|
||||
|
||||
theme: "@vuepress/theme-default",
|
||||
plugins: [
|
||||
"vuepress-plugin-clean-urls",
|
||||
],
|
||||
markdown: {
|
||||
extendMarkdown: md => {
|
||||
md.use(require("markdown-it-custom-header-link"));
|
||||
md.use(require("markdown-it-imsize"));
|
||||
}
|
||||
},
|
||||
|
||||
themeConfig: {
|
||||
nav: [
|
||||
{ text: "Support server", link: "https://discord.gg/PczBt78" },
|
||||
{ text: "Invite bot", link: "https://discordapp.com/oauth2/authorize?client_id=466378653216014359&scope=bot&permissions=536995904" }
|
||||
],
|
||||
sidebar: [
|
||||
["/", "Home"],
|
||||
{
|
||||
title: "User Guide",
|
||||
collapsable: false,
|
||||
children: [
|
||||
"/guide/quick-start",
|
||||
"/guide/systems",
|
||||
"/guide/members",
|
||||
"/guide/proxying",
|
||||
"/guide/moderation",
|
||||
"/guide/privacy",
|
||||
"/guide/commands",
|
||||
]
|
||||
},
|
||||
"/faq",
|
||||
"/api",
|
||||
"/privacy-policy",
|
||||
"/support-server",
|
||||
],
|
||||
lastUpdated: "Last Updated",
|
||||
|
||||
repo: "xSke/PluralKit",
|
||||
repoLabel: "Contribute!",
|
||||
docsDir: "docs/content",
|
||||
editLinks: true,
|
||||
editLinkText: "Help us improve this page!"
|
||||
}
|
||||
}
|
||||
BIN
docs/content/.vuepress/public/favicon.png
Normal file
BIN
docs/content/.vuepress/public/favicon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 664 KiB |
6
docs/content/.vuepress/styles/palette.styl
Normal file
6
docs/content/.vuepress/styles/palette.styl
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
// CUSTOM
|
||||
$exampleBgColor = $codeBgColor;
|
||||
$exampleTextColor = #ffffff;
|
||||
$examplePrefixColor = #a3a6a9;
|
||||
$exampleFontSize = 0.9rem;
|
||||
$exampleFontFamily = source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;
|
||||
Loading…
Add table
Add a link
Reference in a new issue