Migrate docs to Vuepress

This commit is contained in:
Ske
2020-07-28 18:19:40 +02:00
parent a0d4ab5809
commit 8c0cbd6d26
33 changed files with 8035 additions and 421 deletions

27
docs/content/index.md Normal file
View File

@@ -0,0 +1,27 @@
---
# home: true
# heroImage: https://v1.vuepress.vuejs.org/hero.png
# tagline: Documentation for PluralKit
# actionText: Quick Start →
# actionLink: /guide/
# features:
# - title: Feature 1 Title
# details: Feature 1 Description
# - title: Feature 2 Title
# details: Feature 2 Description
# - title: Feature 3 Title
# details: Feature 3 Description
# footer: Made by with ❤️
title: Home
---
# PluralKit
PluralKit is a bot designed for plural communities on Discord. It allows you to register systems, maintain system information, set up message proxying, log switches, and more.
This bot detects messages with certain tags associated with a profile, then replaces that message under a "pseudo-account" of that profile using webhooks. This is useful for multiple people sharing one body (aka "systems"), people who wish to roleplay as different characters without having several accounts, or anyone else who may want to post messages as a different person from the same account.
#### for example...
![demonstration of PluralKit](./assets/demo.gif)
For more information, see the links to the left, or click [here](https://discord.com/oauth2/authorize?client_id=466378653216014359&scope=bot&permissions=536995904) to invite the bot to your server!