liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Migrate docs to Vuepress

Browse Source
This commit is contained in:
Ske
2020-07-28 18:19:40 +02:00
parent a0d4ab5809
commit 8c0cbd6d26
33 changed files with 8035 additions and 421 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -54,19 +54,8 @@ $ docker-compose up -d
(tip: use `scripts/run-test-db.sh` to run a temporary PostgreSQL database on your local system. Requires Docker.)
# Building the docs
The website and documentation are automatically built by GitHub Pages when pushed to the `master` branch. They use [Jekyll 3](https://jekyllrb.com), which requires [Ruby](https://www.ruby-lang.org) and [Bundler](https://bundler.io/).
To build the docs locally, run:
```
$ cd docs/
$ bundle install --path vendor/bundle
$ bundle exec jekyll build
```
To run an auto-reloading server, substitute the last command with:
$ bundle exec jekyll serve
# Documentation
See [the docs/ directory](./docs/README.md)
# License
This project is under the Apache License, Version 2.0. It is available at the following link: https://www.apache.org/licenses/LICENSE-2.0