PluralKit/docs
2020-06-12 15:46:46 +02:00
..
commands Describe flags 2020-06-12 15:46:46 +02:00
content Describe flags 2020-06-12 15:46:46 +02:00
.gitignore Initial docs rewrite using Vuepress 2020-06-10 18:11:28 +02:00
package.json Initial docs rewrite using Vuepress 2020-06-10 18:11:28 +02:00
README.md Initial docs rewrite using Vuepress 2020-06-10 18:11:28 +02:00
yarn.lock Initial docs rewrite using Vuepress 2020-06-10 18:11:28 +02:00

PluralKit docs

The documentation is built using Vuepress. All website content is located in the content/ subdirectory.

Building

First, install Node.js and Yarn. Then, run the dev command:

$ yarn
$ yarn dev

This will start a development server on http://localhost:8080/.

Deployment

The docs are deployed using Netlify with CI.