This repo contains the source for the valkey.io website (build scripts, template, blog posts, stylesheets, etc.).
The build integrates content from valkey-io/valkey-doc
and the commands definitions from valkey-io/valkey
via Git submodules.
We welcome contributions! Please see our CONTRIBUTING page to learn more about how to contribute to the website.
If you discover potential security issues, see the reporting instructions on our CONTRIBUTING page for more information.
This site is built using Jekyll 4.3.2 with Ruby 3.3.0. Other versions may work, but YMMV.
- Go to the root of the repo
- Install Ruby and RVM (or some other Ruby version switcher, e.g. chruby)
- Install Jekyll
- Install dependencies:
bundle install
- Build:
bundle exec jekyll serve
for the local server,bundle exec jekyll build
for one off builds. Either way, the HTML of the site is generated to/_site
- Point your browser at
http://127.0.0.1:4000/
docker buildx build -t valkey.io .
docker run --volume="$PWD:/srv:Z" --workdir=/srv -p 3000:4000 valkey.io:latest
- Open browser to
http://localhost:3000/
This project is licensed under the BSD-3-Clause License.