Initial docs rewrite using Vuepress

This commit is contained in:
Ske 2020-06-10 18:11:28 +02:00
parent e7191def02
commit 2b259869a0
47 changed files with 8276 additions and 1397 deletions

View file

@ -0,0 +1 @@
# Command list

View file

@ -0,0 +1,2 @@
# User Guide
guide go nyoom, or something

View file

@ -0,0 +1,7 @@
# Members
## The member card
## Creating members
## Editing members

View file

@ -0,0 +1,7 @@
# Moderation
## Message querying
## Channel blacklist
## Log channel
### Logging blacklist
## Moderation bots
### Log cleanup

View file

@ -0,0 +1 @@
# Privacy

View file

@ -0,0 +1,13 @@
# Proxying
## Proxy tags
## Handling names
### System tags
### Display names
### Server names
## Querying and pinging
## Autoproxy

View file

@ -0,0 +1,62 @@
---
defaultMember: Craig
---
# Quick start
This page will get you started :zap: lightning-fast :zap: with the bot. You'll need to follow these steps:
## Create a system
First, **create a system** with the following command:
<Cmd>system new</Cmd>
You can also specify a system name if you want:
<Cmd>system new <Arg>My System Name</Arg></Cmd>
## Create a member
Second, **create a member** with the following command, inserting the member name:
<Cmd>member new <Arg>{{ $page.frontmatter.defaultMember }}</Arg></Cmd>
::: tip
You can include spaces, punctuation, or symbols in the member name. However, you'll need to write them `"in quotes"` every time you refer to the member elsewhere.
Instead, you can give your member a simple, easy to type name, then set the member's [display name](./proxying.md#handling-names) to a more complex version. That'll get displayed when proxying, and then you can keep the following commands simple.
:::
## Set some proxy tags
Now, you'll need to tell PluralKit how you want to trigger the proxy using **proxy tags**. Often, these will be a pair of brackets, an emoji prefix, or something similar.
To set a member's proxy tags, you'll need to "pretend" you're proxying the word `text` - just the word itself, all-lowercase. This often gets a bit confusing, so here are a couple of examples with various patterns:
<CmdGroup>
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> proxy <Arg>J:text</Arg></Cmd>
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> proxy <Arg>[text]</Arg></Cmd>
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> proxy <Arg>🌸text</Arg></Cmd>
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> proxy <Arg>text -Q</Arg></Cmd>
</CmdGroup>
::: tip
You're not limited to the types of proxy tags shown above. You can put anything you'd like around the word `text` (before, after, or both), and PluralKit will look for that. Be creative!
:::
## Set an avatar (optional)
If you want an avatar displayed, use the following command:
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> avatar <Arg>https://link.to.your/avatar.png</Arg></Cmd>
::: tip
If you don't have a link, you can leave that out entirely, and then **attach** the image to the command message itself. PluralKit will pick up on the attachment, and use that instead.
:::
::: warning
Avatars have some restrictions:
- The image must be in **.jpg**, **.png**, or **.webp** format
- The image must be under **1024 KB** in size
- The image must be below **1024 x 1024 pixels** in resolution (along the smallest axis).
- Animated GIFs are **not** supported (even if you have Nitro).
:::
## More information
(TODO)

View file

@ -0,0 +1,44 @@
---
systemName: My System Name
---
# Systems
A *system* is equivalent to an account. Every user of PluralKit must have a system registered to use the bot.
## System IDs
Each system has a **system ID** - a randomly generated string of 5 letters. You can use this ID to unambiguously refer to a system in commands.
You can see your system ID by running <Cmd-inline>system</Cmd-inline> and looking at the embed footer (at the bottom of the response).
## Creating a system
To create a system, use the <Cmd-inline>system new</Cmd-inline> command with an optional system name:
<CmdGroup>
<Cmd>system new</Cmd>
<Cmd>system new <Arg>My System Name</Arg></Cmd>
</CmdGroup>
## Editing your system
### System description
You can set your system description using the following command:
<Cmd>system description <Arg>My cool system description goes here.</Arg></Cmd>
## Linking accounts
A system isn't necessarily tied to a single account. A system can be **linked** to another account, and all linked accounts can run commands on behalf of the system.
To link your system to another account, use the following command:
<Cmd>link <Arg>@NameOfAccount#1234</Arg></Cmd>
The other account will need to confirm the link by pressing a reaction within five minutes.
Should you want to unlink an account, use the equivalent unlink account:
<Cmd>unlink <Arg>@NameOfAccount#1234</Arg></Cmd>
You can unlink your own account too (both by mentioning, or using <Cmd-inline>unlink</Cmd-inline> with no account). While you can't unlink the only linked account, be careful not to lock yourself out of your system by other means :slightly_smiling_face:
::: tip
On both of these commands, you can also supply a user ID. This is useful when you want to unlink an already-deleted account, for example.
:::