eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-10 07:47:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Initial docs rewrite using Vuepress

Browse source
This commit is contained in:
Ske 2020-06-10 18:11:28 +02:00
parent e7191def02
commit 2b259869a0
47 changed files with 8276 additions and 1397 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/README.md Normal file
View file

@ -0,0 +1,16 @@
# PluralKit docs
The documentation is built using [Vuepress](https://vuepress.vuejs.org/). All website content is located in the `content/` subdirectory.
## Building
First, install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://classic.yarnpkg.com/en/). Then, run the `dev` command:
```sh
$ yarn
$ yarn dev
```
This will start a development server on http://localhost:8080/.
## Deployment
The docs are deployed using [Netlify](https://www.netlify.com/) with CI.