|
|
||
|---|---|---|
| .. | ||
| content | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
| yarn.lock | ||
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.