diff --git a/README.md b/README.md index 2c18e9d4..9ea1a418 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,17 @@ $ docker-compose up -d * Create and fill in a `pluralkit.conf` file in the same directory as `docker-compose.yml` * Run the bot: `dotnet run --project PluralKit.Bot` +# Building the docs +The website and documentation are automatically built by GitHub Pages when pushed to the `master` branch. They use [Jekyll 3](https://jekyllrb.com), which requires [Ruby](https://www.ruby-lang.org) and [Bundler](https://bundler.io/). + +To build the docs locally, run: +``` +$ cd docs/ +$ bundle install --path vendor/bundle +$ bundle exec jekyll build + +To run an auto-reloading server, substitute the last command with: + $ bundle exec jekyll serve # License This project is under the Apache License, Version 2.0. It is available at the following link: https://www.apache.org/licenses/LICENSE-2.0 \ No newline at end of file diff --git a/docs/1-user-guide.md b/docs/1-user-guide.md index 006e5fbb..06cad30c 100644 --- a/docs/1-user-guide.md +++ b/docs/1-user-guide.md @@ -2,6 +2,7 @@ layout: default title: User Guide permalink: /guide +description: PluralKit's user guide contains a walkthrough of the bot's features, as well as how to use them. --- # User Guide diff --git a/docs/2-command-list.md b/docs/2-command-list.md index 6d2f4b41..d3ea5f2d 100644 --- a/docs/2-command-list.md +++ b/docs/2-command-list.md @@ -2,10 +2,11 @@ layout: default title: Command List permalink: /commands +description: The full list of all commands in PluralKit, and a short description of what they do. --- # How to read this -Words in \ are *required parameters*. Words in [square brackets] are *optional parameters*. Words with ellipses... indicate multiple repeating parameters. +Words in \ are *required parameters*. Words in [square brackets] are *optional parameters*. Words with ellipses... indicate multiple repeating parameters. Note that **you should not include the brackets in the actual command**. # Commands ## System commands diff --git a/docs/3-api-documentation.md b/docs/3-api-documentation.md index 8644eac5..0ef5254f 100644 --- a/docs/3-api-documentation.md +++ b/docs/3-api-documentation.md @@ -2,6 +2,7 @@ layout: default title: API documentation permalink: /api +description: PluralKit's API documentation. --- # API documentation diff --git a/docs/4-privacy-policy.md b/docs/4-privacy-policy.md index 9d481ecc..2a419b1f 100644 --- a/docs/4-privacy-policy.md +++ b/docs/4-privacy-policy.md @@ -2,6 +2,7 @@ layout: default title: Privacy Policy permalink: /privacy +description: I'm not a lawyer. I don't want to write a 50 page document no one wants to (or can) read. It's short, I promise. --- # Privacy Policy diff --git a/docs/5-faq.md b/docs/5-faq.md new file mode 100644 index 00000000..3e216e15 --- /dev/null +++ b/docs/5-faq.md @@ -0,0 +1,21 @@ +--- +layout: default +title: FAQ +permalink: /faq +description: Frequently asked questions (and the answers to them). +--- + +# Frequently asked questions +{: .no_toc } + +1. TOC +{:toc} + +## Can I use this bot for kin/roleplay/other non-plurality uses? Can I use it if I'm not plural myself? Is that appropriating? +Although this bot is designed with plural systems and their use cases in mind, the bot's feature set is still useful for many other types of communities, including role-playing and otherkin. By all means go ahead and use it for those communities, too. We don't gatekeep, and neither should you. + +## Who's the mascot? +[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) diff --git a/docs/Gemfile b/docs/Gemfile index 14a8769c..a9a086ec 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,2 +1,3 @@ source "https://rubygems.org" -gem 'github-pages', group: :jekyll_plugins \ No newline at end of file +gem 'github-pages', group: :jekyll_plugins +gem 'wdm', '>= 0.1.0' if Gem.win_platform? diff --git a/docs/assets/myriad.png b/docs/assets/myriad.png new file mode 100644 index 00000000..d58bd01a Binary files /dev/null and b/docs/assets/myriad.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 00000000..cb81c4f3 Binary files /dev/null and b/docs/favicon.ico differ