eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-04 04:56:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
PluralKit/docs
History
Nidoskull b73dd370d1
docs: multiple docs updates (#712) 
* docs: user-guide, timezone clear

Fix docs-to-commands inconsistency. Now properly says how to clear your set timezone.

* docs: user-guide, group privacy

Adds in detailed docs on group privacy (mostly copy-pasted from member privacy).

* docs: user-guide, ping 🛎 reaction

Lists the :bellhop: reaction as something that will trigger the "ping alter" behavior.

* docs: user-guide, group privacy 2

Re-ordered to be consistent with command `pk;g <group> privacy` output & fixed leftover error from copy/pasting too hard from members.

* docs: command-list, pk;sw add > pk;sw copy

Replaces primary alias of pk;switch add to pk;switch copy following discussion on Discord.
https://discord.com/channels/466707357099884544/1314433710250266632/1314608434951360552
2024-12-10 15:43:45 -07:00
..
content docs: multiple docs updates (#712) 2024-12-10 15:43:45 -07:00
.gitignore Migrate docs to Vuepress 2020-07-28 18:19:40 +02:00
package.json chore: remove plausible analytics entirely 2023-01-15 17:09:13 +00:00
README.md Minor layout/content tweaks 2020-07-28 18:47:26 +02:00
yarn.lock chore: remove plausible analytics entirely 2023-01-15 17:09:13 +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.