History

spiral 71461b3163 Add looking up group by displayname; document this		2020-11-14 10:42:51 -05:00
..
content	Add looking up group by displayname; document this	2020-11-14 10:42:51 -05:00
.gitignore	Migrate docs to Vuepress	2020-07-28 18:19:40 +02:00
package.json	Relicense project to AGPLv3	2020-11-08 18:52:36 +01:00
README.md	Minor layout/content tweaks	2020-07-28 18:47:26 +02:00
yarn.lock	Bump prismjs from 1.20.0 to 1.21.0 in /docs	2020-08-08 00:44:15 +00:00

README.md

PluralKit docs

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

Most site parameters, including the sidebar layout, are defined in content/.vuepress/config.js. Some additional CSS is defined in content/.vuepress/styles.

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/. 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.

Deployment

The docs are deployed using Netlify with CI.