https://github.com/redis/redis-website
https://github.com/redis/redis-website
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/redis/redis-website
- Owner: redis
- License: apache-2.0
- Created: 2021-11-23T20:52:24.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-06T20:21:42.000Z (about 2 years ago)
- Last Synced: 2025-07-09T00:25:50.513Z (5 months ago)
- Language: HTML
- Size: 1.11 MB
- Stars: 9
- Watchers: 4
- Forks: 20
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redis website
This project is a [Docsy][], which is a [Hugo theme][], that's adapted for Redis' documentation website.
When cloning, make sure to bring in the submodules:
```bash
git clone --recurse-submodules --depth 1 https://github.com/redis/redis-website.git
```
Note: if you want to do SCSS edits and want to publish these, you need to install `PostCSS`
```bash
npm install postcss
```
## Running the website locally
Building and running the site locally requires a recent `extended` version of [Hugo](https://gohugo.io).
You can find out more about how to install Hugo for your environment in Docsy's
[Getting started](https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation) guide.
**IMPORTANT**: you'll also need the [`redis-doc/new-structure`](https://github.com/redis/redis-doc/tree/new-structure) branch for this to work.
Once you've made your working copy of the site repo, from the repo root folder, run:
```bash
REDIS_DOC=/home/you/redis-doc make
hugo server --disableFastRender
```
The website should be up and running on http://localhost:1313/ now.
[Docsy]: https://github.com/google/docsy
[Hugo theme]: https://gohugo.io/themes/installing-and-using-themes/