History

rladenson 0051ccf2fb Update user-guide.md It said that pk doesn't have some things that have since been implemented.		2021-05-08 01:10:32 -06:00
..
content	Update user-guide.md	2021-05-08 01:10:32 -06:00
.gitignore	Migrate docs to Vuepress	2020-07-28 18:19:40 +02:00
package.json	Merge pull request #229 from dev-kittens/dark-docs	2020-12-08 12:22:40 +01:00
README.md	Minor layout/content tweaks	2020-07-28 18:47:26 +02:00
yarn.lock	Use prefers-color-scheme for dark theme docs	2020-10-09 18:54:46 +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.