History

dependabot[bot] 8809320d81 build(deps): bump url-parse from 1.5.1 to 1.5.3 in /docs (#393 ) Bumps [url-parse](https://github.com/unshiftio/url-parse) from 1.5.1 to 1.5.3. - [Release notes](https://github.com/unshiftio/url-parse/releases) - [Commits](https://github.com/unshiftio/url-parse/compare/1.5.1...1.5.3) --- updated-dependencies: - dependency-name: url-parse dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>		2021-09-26 22:00:17 -04:00
..
content	Add switch editing functionality	2021-09-26 20:08:38 -04:00
.gitignore	Migrate docs to Vuepress	2020-07-28 18:19:40 +02:00
package.json	docs: update dependencies	2021-06-11 21:08:28 +00:00
README.md	Minor layout/content tweaks	2020-07-28 18:47:26 +02:00
yarn.lock	build(deps): bump url-parse from 1.5.1 to 1.5.3 in /docs (#393 )	2021-09-26 22:00:17 -04: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.