diff --git a/docs/content/.vuepress/components/Arg.vue b/docs/content/.vuepress/components/Arg.vue index 5263bcb0..7c849ff2 100644 --- a/docs/content/.vuepress/components/Arg.vue +++ b/docs/content/.vuepress/components/Arg.vue @@ -1,38 +1,30 @@  \ No newline at end of file diff --git a/docs/content/.vuepress/components/Cmd.vue b/docs/content/.vuepress/components/Cmd.vue index 00ebb685..e324aacf 100644 --- a/docs/content/.vuepress/components/Cmd.vue +++ b/docs/content/.vuepress/components/Cmd.vue @@ -1,55 +1,70 @@  - \ No newline at end of file diff --git a/docs/content/.vuepress/config.js b/docs/content/.vuepress/config.js index 5f4e2e21..1579a758 100644 --- a/docs/content/.vuepress/config.js +++ b/docs/content/.vuepress/config.js @@ -30,6 +30,8 @@ module.exports = { collapsable: false, children: [ "/guide/quick-start", + "/guide/ids", + "/guide/listing", "/guide/systems", "/guide/members", "/guide/proxying", diff --git a/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-500.woff b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-500.woff new file mode 100644 index 00000000..84aa3e6f Binary files /dev/null and b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-500.woff differ diff --git a/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-500.woff2 b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-500.woff2 new file mode 100644 index 00000000..1d5a0f5e Binary files /dev/null and b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-500.woff2 differ diff --git a/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-600.woff b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-600.woff new file mode 100644 index 00000000..991aec6d Binary files /dev/null and b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-600.woff differ diff --git a/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-600.woff2 b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-600.woff2 new file mode 100644 index 00000000..b001471c Binary files /dev/null and b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-600.woff2 differ diff --git a/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-regular.woff b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-regular.woff new file mode 100644 index 00000000..03df1e06 Binary files /dev/null and b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-regular.woff differ diff --git a/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-regular.woff2 b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-regular.woff2 new file mode 100644 index 00000000..3e406a7b Binary files /dev/null and b/docs/content/.vuepress/public/fonts/inconsolata-v19-latin-regular.woff2 differ diff --git a/docs/content/.vuepress/styles/index.styl b/docs/content/.vuepress/styles/index.styl new file mode 100644 index 00000000..9609c0b5 --- /dev/null +++ b/docs/content/.vuepress/styles/index.styl @@ -0,0 +1,34 @@ +/* inconsolata-regular - latin */ +@font-face { + font-family: 'Inconsolata'; + font-style: normal; + font-weight: 400; + src: local(''), + url('/fonts/inconsolata-v19-latin-regular.woff2') format('woff2'), /* Chrome 26+, Opera 23+, Firefox 39+ */ + url('/fonts/inconsolata-v19-latin-regular.woff') format('woff'); /* Chrome 6+, Firefox 3.6+, IE 9+, Safari 5.1+ */ +} + +/* inconsolata-500 - latin */ +@font-face { + font-family: 'Inconsolata'; + font-style: normal; + font-weight: 500; + src: local(''), + url('/fonts/inconsolata-v19-latin-500.woff2') format('woff2'), /* Chrome 26+, Opera 23+, Firefox 39+ */ + url('/fonts/inconsolata-v19-latin-500.woff') format('woff'); /* Chrome 6+, Firefox 3.6+, IE 9+, Safari 5.1+ */ +} + +/* inconsolata-600 - latin */ +@font-face { + font-family: 'Inconsolata'; + font-style: normal; + font-weight: 600; + src: local(''), + url('/fonts/inconsolata-v19-latin-600.woff2') format('woff2'), /* Chrome 26+, Opera 23+, Firefox 39+ */ + url('/fonts/inconsolata-v19-latin-600.woff') format('woff'); /* Chrome 6+, Firefox 3.6+, IE 9+, Safari 5.1+ */ +} + +.line-number, code, pre, kbd, .cmd, .cmd-arg { + font-family: $monoFont; + font-weight: $monoWeight; +} \ No newline at end of file diff --git a/docs/content/.vuepress/styles/palette.styl b/docs/content/.vuepress/styles/palette.styl index ef410862..f4566f22 100644 --- a/docs/content/.vuepress/styles/palette.styl +++ b/docs/content/.vuepress/styles/palette.styl @@ -1,18 +1,18 @@ // THEME $textColor = #2c3e50; -$accentColor = darken(#e8a024, 10%); +$accentColor = darken(#e8a024, 10%) -// CUSTOM -$exampleBgColor = #f3f5f7; -$exampleBgColorInTip = darken($exampleBgColor, 4%); -$exampleTextColor = darken($textColor, 5%); -$exampleArgColor = darken($exampleBgColor, 1%); -$exampleArgColorInExample = darken($exampleBgColor, 4%); -$exampleArgColorInTip = darken($exampleBgColor, 3%); -$exampleArgColorInBoth = darken($exampleBgColor, 8%); -$tipDarkenFactor = 3; -$exampleDarkenFactor = 5; -$exampleCommentColor = darken($accentColor, 15%); -$examplePrefixColor = desaturate(lighten($exampleCommentColor, 20%), 10%); -$exampleFontSize = 0.9rem; -$exampleFontFamily = source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace; \ No newline at end of file +// COMMANDS +$cmdColor = #f8fafc; + +$cmdBgBlock = #282c34; +$cmdBgInline = darken(#f3f5f7, 4%); +$cmdBgInlineTip = darken(#f3f5f7, 5%); + +$argBgPlain = darken(#f3f5f7, 4%); +$argBgInline = darken(#f3f5f7, 5%); +$argBgBlock = lighten($cmdBgBlock, 15%); + +// FONTS +$monoFont = Inconsolata, source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace; +$monoWeight = 500; diff --git a/docs/content/guide/commands.md b/docs/content/guide/commands.md index 95395a5e..e6c38adc 100644 --- a/docs/content/guide/commands.md +++ b/docs/content/guide/commands.md @@ -1,24 +1,53 @@ # Command list +This page shows a list of all commands PluralKit supports. -::: tip HOW TO READ THIS PAGE -Below is a list of all the commands the bot supports. +## How to read this page +The first block for each command, **Usage**, shows the format of each command. This is essentially a "template" you'll need to fill in. +The parts you can change are called **arguments**, and they're highlighted. -Highlighted spaces (eg. system-name ) are **arguments**, and you should **fill in the blank** with the relevant bit of text. -The **Arguments** section below each command describes how to fill it in, and what type of value goes there. +### Arguments +The command's **Arguments** section will describe how to fill them in, and what you need to put there. -When an argument asks for a **system ID**, you can either fill in a system's [5-character ID](./ids.md), **or** you can fill in a Discord account ID, or even a @mention. For example: +::: details Example of a command with an argument +Here's an example of a command with an argument: +some-command this-is-an-argument + +When running this command, fill in the argument like so: +some-command My cool text +::: + +### Systems and members +Some commands accept a **target system or member**: + +For **systems**, this can either be a [5-character ID](./ids.md), a `@mention`, or a [Discord user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-). +In many cases you can leave the system out entirely. Instead, it'll just use your own system. + +For **members**, this can be the member's name or their [5-character ID](./ids). + +::: details Example of referring to systems -system exmpl -system 466378653216014359 list -system @PluralKit#4020 fronter +system list +system abcde list +system @Myriad#1234 list +system 466378653216014359 list +::: -When an argument asks for a **member ID**, you can either fill in a member's [5-character ID](./ids.md), or, *if the member is in your own system*, their name. This means that to target a member in another system, you **must** use their ID. +::: details Example of referring to members + +member Myriad info +member "Myriad Kit" +member zxcvb info + +::: + +::: warning +If you're trying to refer to a member with **spaces or emojis** in their name, you'll need to wrap the name in either 'single' or "double" quotes. Alternatively, you can use the [member ID](./ids). ::: ## System commands ::: tip -You can use s instead of system as a short-hand. +You can use s instead of system as a short-hand. ::: @@ -28,10 +57,10 @@ You can use s instead of system as ## Member commands ::: tip -You can use m instead of member as a short-hand. +You can use m instead of member as a short-hand. ::: ## Switch commands ::: tip -You can use sw instead of switch as a short-hand. +You can use sw instead of switch as a short-hand. ::: \ No newline at end of file diff --git a/docs/content/guide/ids.md b/docs/content/guide/ids.md index 92f102a7..b10d7e03 100644 --- a/docs/content/guide/ids.md +++ b/docs/content/guide/ids.md @@ -1,2 +1,45 @@ -# System and member IDs -hi! \ No newline at end of file +# IDs +Most "things" in PluralKit have a randomly assigned **5-character ID**. When you create a new system or a new member, +an ID will be generated for that system or member. + +The IDs are always lowercase letters, and will look something like this: `zxcvb`. They generally won't spell anything readable, +but given their random nature, occasionally they'll produce a word. Consider it a bonus! (unless it's a slur or something rude, in which case [ask me to change it](../support-server.md)) + +## Finding your IDs +To find your own system ID, look up your own system card using the system command. The system ID will display in the card's footer, like so: + +TODO: insert example with highlighted ID + +To find a member ID, you can similarly look up the member by name using the member member-name command, like so: + +TODO: insert example with highlighted ID (showing command invocation) + + +You can also [look at your member list](./listing.md), and each member's ID will be shown on the left-hand side, like so: + +TODO: insert example with highlighted ID (showing command invocation) + +## Where can I use it? +IDs are the universal way of uniquely referring to a system or member. Most commands will allow you to enter a relevant ID: + + +system system-id +system system-id list +member member-id +switch member-id-1 member-id-2 + + +**System IDs** can also be written as either an account `@mention` or a numeric [Discord user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-). This will refer to the system linked to that account. + +**Member IDs** can be used instead of member names in most commands. This is especially useful if a member has spaces or symbols in the username; using the member ID lets you avoid messing with "quotes", emojis, special keyboards, etc. + +::: details Example +Take a member with the name `Myriad "Big Boss" Kit ✨`. This member has the ID `asdfg`. + +When running a command on this member (eg. changing their description), both of these will work: + + +member 'Myriad "Big Boss" Kit ✨' description My new description! +member asdfg description My new description! + +::: \ No newline at end of file diff --git a/docs/content/guide/listing.md b/docs/content/guide/listing.md new file mode 100644 index 00000000..6685c3f6 --- /dev/null +++ b/docs/content/guide/listing.md @@ -0,0 +1 @@ +# Listing members \ No newline at end of file diff --git a/docs/content/guide/systems.md b/docs/content/guide/systems.md index 19a40221..5674823e 100644 --- a/docs/content/guide/systems.md +++ b/docs/content/guide/systems.md @@ -8,10 +8,10 @@ A *system* is equivalent to an account. Every user of PluralKit must have a syst ## 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 system and looking at the embed footer (at the bottom of the response). +You can see your system ID by running system and looking at the embed footer (at the bottom of the response). ## Creating a system -To create a system, use the system new command with an optional system name: +To create a system, use the system new command with an optional system name: system new @@ -37,7 +37,7 @@ Should you want to unlink an account, use the equivalent unlink account: unlink @NameOfAccount#1234 -You can unlink your own account too (both by mentioning, or using unlink 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: +You can unlink your own account too (both by mentioning, or using unlink 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.