liz/PluralKit
liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f984875145
PluralKit/docs
History
dependabot[bot] f984875145
Bump prismjs from 1.20.0 to 1.21.0 in /docs 
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.20.0 to 1.21.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.20.0...v1.21.0)

Signed-off-by: dependabot[bot] <support@github.com>
2020-08-08 00:44:15 +00:00
..
content fix formatting 2020-07-29 11:30:46 +02:00
.gitignore Migrate docs to Vuepress 2020-07-28 18:19:40 +02:00
package.json Minor layout/content tweaks 2020-07-28 18:47:26 +02:00
README.md Minor layout/content tweaks 2020-07-28 18:47:26 +02:00
yarn.lock Bump prismjs from 1.20.0 to 1.21.0 in /docs 2020-08-08 00:44:15 +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.