liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a146079a01
PluralKit/docs
History
dependabot[bot] a146079a01
build(deps): bump prismjs from 1.24.1 to 1.25.0 in /docs (#392) 
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.24.1 to 1.25.0.
- [Release notes](https://github.com/PrismJS/prism/releases)
- [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PrismJS/prism/compare/v1.24.1...v1.25.0)

---
updated-dependencies:
- dependency-name: prismjs
  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 20:54:34 -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 prismjs from 1.24.1 to 1.25.0 in /docs (#392) 2021-09-26 20:54:34 -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.