Minor layout/content tweaks
This commit is contained in:
Ske
parent
76f9aa9a62
commit
0fadc81cda
@ -11,7 +11,7 @@ $ yarn
|
||||
$ yarn dev
|
||||
```
|
||||
|
||||
This will start a development server on http://localhost:8080/.
|
||||
This will start a development server on http://localhost:8080/. Note that changes to the sidebar or similar generally need a full restart (Ctrl-C) to take effect, while content-only changes will hot-reload.
|
||||
|
||||
For a full HTML build, run `yarn build`. Files will be output in `content/.vuepress/dist` by default.
|
||||
|
||||
|
||||
@ -13,7 +13,6 @@ module.exports = {
|
||||
markdown: {
|
||||
extendMarkdown: md => {
|
||||
md.use(require("markdown-it-custom-header-link"));
|
||||
md.use(require("markdown-it-imsize"));
|
||||
}
|
||||
},
|
||||
|
||||
@ -24,14 +23,15 @@ module.exports = {
|
||||
editLinks: true,
|
||||
editLinkText: 'Help us improve this page!',
|
||||
lastUpdated: "Last updated",
|
||||
nextLinks: false,
|
||||
prevLinks: false,
|
||||
nextLinks: true,
|
||||
prevLinks: true,
|
||||
nav: [
|
||||
{ text: "Support server", link: "https://discord.gg/PczBt78" },
|
||||
{ text: "Invite bot", link: "https://discord.com/oauth2/authorize?client_id=466378653216014359&scope=bot&permissions=536995904" }
|
||||
],
|
||||
sidebar: [
|
||||
"/",
|
||||
["https://discord.com/oauth2/authorize?client_id=466378653216014359&scope=bot&permissions=536995904", "Add to your server"],
|
||||
{
|
||||
title: "Documentation",
|
||||
collapsable: false,
|
||||
@ -47,13 +47,11 @@ module.exports = {
|
||||
]
|
||||
},
|
||||
["https://discord.gg/PczBt78", "Join the support server"],
|
||||
["https://discord.com/oauth2/authorize?client_id=466378653216014359&scope=bot&permissions=536995904", "Add to your server"],
|
||||
]
|
||||
},
|
||||
|
||||
plugins: [
|
||||
'@vuepress/plugin-back-to-top',
|
||||
'@vuepress/plugin-medium-zoom',
|
||||
[
|
||||
'@vuepress/google-analytics',
|
||||
{
|
||||
|
||||
@ -1,7 +1,13 @@
|
||||
// For custom styles
|
||||
// See: https://vuepress.vuejs.org/config/#index-styl
|
||||
|
||||
// Center images on page (only relevant when resized with markdown-it-imsize)
|
||||
img
|
||||
// Center images on page
|
||||
display block
|
||||
margin auto
|
||||
|
||||
// This is a strange hack to prevent "portrait" images from blowing up vertically
|
||||
// We previously used `markdown-it-imsize`, but that'd start squashing the images on mobile...
|
||||
// So, we set an arbitrary maximuim height for images. This may need to change in the future.
|
||||
// (see the system/member cards in getting-started.md for examples of why this is necessary)
|
||||
max-height 450px
|
||||
|
||||
@ -4,7 +4,7 @@ description: PluralKit's API documentation.
|
||||
permalink: /api
|
||||
---
|
||||
|
||||
**2020-05-07**: The PluralKit API is now documented on Swagger: https://app.swaggerhub.com/apis-docs/xSke/PluralKit/1.1
|
||||
**2020-05-07**: [The PluralKit API is now documented on Swagger.](https://app.swaggerhub.com/apis-docs/xSke/PluralKit/1.1)
|
||||
Accompanying it is an [OpenAPI v3.0 definition](https://github.com/xSke/PluralKit/blob/master/PluralKit.API/openapi.yaml). It's mostly complete, but is still subject to change - so don't go generating API clients and mock servers with it quite yet. It may still be useful, though :)
|
||||
|
||||
# API documentation
|
||||
|
||||
@ -12,7 +12,7 @@ Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank.
|
||||
# Commands
|
||||
## System commands
|
||||
*Optionally replace `[system]` with a @mention, Discord account ID, or 5-character ID. For most commands, adding `-clear` will clear/delete the field.*
|
||||
- `pk;system [id]` - Shows information about a system.
|
||||
- `pk;system [system]` - Shows information about a system.
|
||||
- `pk;system new [name]` - Creates a new system registered to your account.
|
||||
- `pk;system rename [new name]` - Changes the name of your system.
|
||||
- `pk;system description [description]` - Changes the description of your system.
|
||||
|
||||
@ -13,4 +13,4 @@ Although this bot is designed with plural systems and their use cases in mind, t
|
||||
[Our lovely bot mascot](https://imgur.com/a/LTqQHHL)'s name is Myriad! They were drawn by the lovely [Layl](https://twitter.com/braindemons). Yes, there are fictives.
|
||||
|
||||
## How can I support the bot's development?
|
||||
I (the bot author, [Ske](https://twitter.com/floofstrid) have a Patreon. The income from there goes towards server hosting, domains, infrastructure, my Monster Energy addiction, et cetera. There are no benefits. There might never be any. But nevertheless, it can be found here: [https://www.patreon.com/floofstrid](https://www.patreon.com/floofstrid)
|
||||
I (the bot author, [Ske](https://twitter.com/floofstrid)) have a Patreon. The income from there goes towards server hosting, domains, infrastructure, my Monster Energy addiction, et cetera. There are no benefits. There might never be any. But nevertheless, it can be found here: [https://www.patreon.com/floofstrid](https://www.patreon.com/floofstrid)
|
||||
|
||||
@ -2,6 +2,9 @@
|
||||
title: Getting Started
|
||||
description: A basic tutorial of how to set up the bot.
|
||||
permalink: /start
|
||||
|
||||
# Previous page on sidebar is the invite link, prevent that from showing up here
|
||||
prev: false
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
@ -9,7 +12,7 @@ permalink: /start
|
||||
## The system
|
||||
The first thing you need to do to use PluralKit is to set up a system! Each account can have one system, but you can link one system to multiple accounts. To inspect a system, you can pull up its *system card*. Below is an example system with all options set, which you can also see by typing `pk;system exmpl` on Discord:
|
||||
|
||||
|
||||
|
||||
|
||||
### Parts of the system
|
||||
These are the parts of the system, reading the card top to bottom left to right like a book:
|
||||
@ -31,7 +34,7 @@ If you want to do tweak the system, [see the user guide](/guide#system-managemen
|
||||
## Members
|
||||
Once you have created a system, the next thing you need to get started is to create a member! Like before, here is an example of a full member card with all options used:
|
||||
|
||||
|
||||
|
||||
|
||||
### Parts to a member
|
||||
These are the parts of a member, reading the card top to bottom left to right like a book:
|
||||
@ -53,7 +56,7 @@ These are the parts of a member, reading the card top to bottom left to right li
|
||||
This is just as easy as creating a system, but there are a few more things you will want to do immediately after. First you run `pk;member new <name>`, so if you want to create a member named Myriad, you would run `pk;member new Myriad`.
|
||||
Next, for proxying later, you will want to set an avatar for your new member! This is done simply by using `pk;member <member> avatar <link to avatar>`. For example,
|
||||
```
|
||||
pk;member Myriad avatar http://pluralkit.me/assets/myriad.png
|
||||
pk;member Myriad avatar https://pluralkit.me/assets/myriad.png
|
||||
```
|
||||
|
||||
You can also leave out the image link, and instead attach an image with the command. That'll work too!
|
||||
@ -65,7 +68,7 @@ For more info on what you can do with members, check out [the member management
|
||||
## Proxies
|
||||
Proxies are probably the most important part of PluralKit, they are literally what the bot was made for. Below is an example of a proxied message:
|
||||
|
||||
|
||||
|
||||
|
||||
### Parts to a proxy message
|
||||
1. **The name**: This is the member's name, display name, or server nickname, depending on what's set (server nickname overrides display name, which overrides the normal name). In this case, it's **Myriad "Big Boss" Kit**.
|
||||
@ -110,15 +113,15 @@ For a more detailed guide on proxying, have a look at the [proxying section of t
|
||||
### Reactions
|
||||
When you come across a proxied message, or you have proxied a message, there are a few handy reactions you can add to the message for some more functionality!
|
||||
|
||||
❌ (red X): This reaction will cause the message to be deleted, but only if you are using the account that sent the message.
|
||||
:x: (red X): This reaction will cause the message to be deleted, but only if you are using the account that sent the message.
|
||||
|
||||
❓ (question mark): This reaction will DM you a message containing details on who sent the message, the member that it proxied, and the system it was from. When you react with this, you will receive a DM that looks like this:
|
||||
:question: (question mark): This reaction will DM you a message containing details on who sent the message, the member that it proxied, and the system it was from. When you react with this, you will receive a DM that looks like this:
|
||||
|
||||
|
||||
|
||||
|
||||
❗ (exclamation mark): This reaction will send a message to the channel the proxied message was sent in, pinging both you and the sender of the message. That message will look like this:
|
||||
:exclamation: (exclamation mark): This reaction will send a message to the channel the proxied message was sent in, pinging both you and the sender of the message. That message will look like this:
|
||||
|
||||
|
||||
|
||||
|
||||
### More proxy examples
|
||||
How to read these examples: The smaller code block with "Example Message" in it is the message you would like to proxy, the larger code block immediately after it is the command you would need to set the member Myriad to respond to that proxy
|
||||
|
||||
@ -2,6 +2,9 @@
|
||||
layout: default
|
||||
permalink: /tips
|
||||
title: Tips and Tricks
|
||||
|
||||
# Next page on sidebar is the support server link, prevent that from showing up here
|
||||
next: false
|
||||
---
|
||||
|
||||
# Tips and Tricks
|
||||
|
||||
@ -297,12 +297,12 @@ The practical effect of this is:
|
||||
### Querying message information
|
||||
If you want information about a proxied message (eg. for moderation reasons), you can query the message for its sender account, system, member, etc.
|
||||
|
||||
Either you can react to the message itself with the ❔ or ❓ emoji, which will DM you information about the message in question,
|
||||
Either you can react to the message itself with the :grey_question: or :question: emoji, which will DM you information about the message in question,
|
||||
or you can use the `pk;message` command followed by [the message's ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-).
|
||||
|
||||
### Pinging a specific user
|
||||
If you'd like to "ping" the account behind a proxied message without having to query the message and ping them yourself,
|
||||
you can react to the message with the 🔔 or ❗ emoji, and PluralKit will ping the relevant member and account in the same
|
||||
you can react to the message with the :bell: or :exclamation: emoji (or even :ping_pong:), and PluralKit will ping the relevant member and account in the same
|
||||
channel on your behalf with a link to the message you reacted to.
|
||||
|
||||
### Disabling proxying on a per-server basis
|
||||
@ -311,7 +311,7 @@ use a different proxy bot there), you can type `pk;system proxy on/off` to do th
|
||||
|
||||
### Deleting messages
|
||||
Since the messages will be posted by PluralKit's webhook, there's no way to delete the message as you would a normal user message.
|
||||
To delete a PluralKit-proxied message, you can react to it with the ❌ emoji. Note that this only works if the message has
|
||||
To delete a PluralKit-proxied message, you can react to it with the :x: emoji. Note that this only works if the message has
|
||||
been sent from your own account.
|
||||
|
||||
### Autoproxying
|
||||
|
||||
@ -10,9 +10,7 @@
|
||||
"devDependencies": {
|
||||
"@vuepress/plugin-back-to-top": "^1.3.1",
|
||||
"@vuepress/plugin-google-analytics": "^1.5.2",
|
||||
"@vuepress/plugin-medium-zoom": "^1.3.1",
|
||||
"markdown-it-custom-header-link": "^1.0.5",
|
||||
"markdown-it-imsize": "^2.0.1",
|
||||
"vuepress": "^1.3.1",
|
||||
"vuepress-plugin-clean-urls": "^1.1.1",
|
||||
"vuepress-plugin-dehydrate": "^1.1.4"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user