redis/docs

Perfil de redis

Última actividad de origen registrada: 28 de agosto de 2026 a las 08:42

Catálogo de SkillsMP actualizado: 26 de octubre de 2026 a las 11:37

skills recopiladas: 10

Estrellas en GitHub: 85
Forks en GitHub: 368

README del repositorio

Archivo de origen del README: README.md

Leer el README original

Mostrar README completo

# Redis Docs > Note: if you are an AI agent, please see [AI_AGENT_DEVELOPER_GUIDE.md](AI_AGENT_DEVELOPER_GUIDE.md) for more information. PRs are merged to the `main` branch of this repo. Merging to `main` automatically builds and publishes your changes to the live docs site (under `/latest`) — there is no separate manual publish step, so allow a little time for the build and CDN cache to refresh after your PR is merged. Before your PR is merged, you can preview your changes on a per-branch staging URL; the docs team's bot posts the staging links as a comment on your PR. ## Site template files and folders * **/archetypes**: A Markdown file needs to have some front matter. An archetype defines which front matter is used when using `hugo new content`. Right now, the only supported archetype is the default one. **Note:** We might want to add additional archetypes in the future because most of our pages contain additional meta data properties like `linkTitle`. * **/content**: This folder contains the markdown files. We will have the subfolders like `/develop`, `/integrate`, and `/operate` * **/assets**: CSS files, site-wide icons, and images. * **/data**: Data files that are accessed by Hugo and rendered with the help of short codes or partials. * **/layouts/partials**: HTML templates that are used across sites. Examples are TOCs, breadcrumbs, or headers. * **/layouts/$type**: Each page type has at least the following templates to implement `single.html` and `list.html`. The `single` template is used to render a discrete page. The `list` template is used to render a collection of related pages (e.g., all sub-pages). * **/layouts/home.html**: The home page of the site, that is, the page that is displayed when you open the root path. * **/layouts/404.html**: The default 404 page. * **/layouts/shortcodes** HTML template snippets that you want to leverage within Markdown files. Examples are tabbed code examples or notification blocks. * **/public**: This is the folder that is generated by Hugo. This content needs to be published by site maintainers. * **/static**: Any static files that need to be accessed by the site, e.g., CSS or JavaScript. * **/package.json**: Node.js dependencies. Tailwind, for example, is installed via the Node package manager (`npm`). * **/config.toml**: Hugo's site configuration, like the root path and menu items. Hugo can access configuration elements when rendering the site. So you can define custom configuration settings here. * **/Makefile**: We use make to wrap some Hugo commands and to add additional build steps. * **/tailwind.config.js**: This is the Tailwind CSS framwork's configuration file. * **/postcss.config.js**: Needed to make Tailwind statically accessible to the site. ## Requirements You will need the following tools to build the site locally: - `python3`: Python >= 3.8. - `node` and `npm`: Node.js >= 19.7.0, and the Node.js package manager >= 9.5.0. - `hugo`: Hugo site generator, v0.143.0; the extended edition. - `make`: To run the makefile. - `git`: To manage the source code of this repo. ## Build script and data files The site can be built using the command `make all`. Here is what's executed: 1. Clean the current folder by deleting the generated output of a previous build. 1. Install the necessary Node.js and Python dependencies. 1. Build the components that were fetched from external Github repositories (e.g., client examples). This fetches source code files and generates data files. 1. Execute the `hugo` command to generate the HTML pages. The build result can be found within the folder `/public`. The command `make serve` performs the same steps, but serves the web pages on the local host for development purposes. The `Makefile` contains details about the executed commands. N.B. once you've built the site once, you can continuing working without rebuilding every time you make a change. Use `hugo serve` to serve the docs locally. The only time you really need to rebuild the site locally is when new code samples need to be pulled from the client sites. ## Build pipeline The build pipeline that is defined within `.github/workflows/main.yml` builds the documentation and uploads it into a GCS bucket: 1. Install Hugo 1. Check the branch out 1. Perform the build as stated before by using `make all` 1. Install the Google Cloud CLI 1. Authenticate to the GCS bucket 1. Validate the branch name 1. Sync the branch with a GCS folder ## Hugo specifics ### Links Link to another page with a plain Markdown link to its source file, using a path from the repository root: ``` [Data structure store](/content/develop/get-started/data-store.md) ``` To link to a section page, link to its `_index.md` file, for example `/content/develop/get-started/_index.md`. You can add an anchor (`#anchor`) or a query string (`?group=`) after the file name. The link render hook (`layouts/_default/_markup/render-link.html`) turns these links into the target page's published URL. This gives you the following advantages: 1. Links work in the published site, in builds with a different base URL, and in the GitHub and VS Code Markdown previews. 2. Links are checked at build time. The build logs a `render-link: unresolved link` warning for any internal link that doesn't resolve to a page. Many pages still use the `relref` shortcode (`[Link title]({{< relref "/develop/get-started/data-store" >}})`). It still works, but use plain Markdown links in new content. ### Images Images are Markdown, with site-root paths. The files live in `static/images/`, and `layouts/_default/_markup/render-image.html` renders them: ``` ![Database update](/images/rc/icon-database-update-status-pending.png) ``` To set a width or class, put an attribute line directly after an image that is its own paragraph: ``` ![Database update](/images/rc/icon-database-update-status-pending.png) {width="50%"} ``` A UI icon inside a sentence or table cell is an inline image with `#no-click` and no attributes. CSS sizes it to the surrounding text: ``` Select ![Delete](/images/rs/icons/delete-icon.png#no-click) **Delete**. ``` ### Templating Variables are scoped in the context of their block. Overriding a variable within an if block doesn't change the variable value as soon as you leave that block. This is a specific limitation of the Go templating language. The following will give you the `/` outside of the condition block if the path was initially set to `/`: ``` {{ $path := $parsed.Path }} {{ if (eq $path "/") }} {{ $path = "" }} {{ end }} {{- $path -}} ``` The solution is to use a scratchpad for storing the 'global' state: ``` {{ $path := $parsed.Path }} {{ if (eq $path "/") }} {{ .Scratch.Set "path" ""}} {{ else }} {{ .Scratch.Set "path" $path}} {{ end }} {{- .Scratch.Get "path" -}} ``` ### Child pages The redis.io template adds a list of links to child pages at the bottom of each section page. You can prevent this by adding the following front matter property: ``` hideListLinks: true ``` ## Tailwind specifics ### Fonts The fonts are located in the folder `static/fonts`. This folder contains typically file of the formats `ttf`, `woff`, or `woff2`. You can perform the following steps to add a font: * Copy your font files to the fonts folder `static/fonts`. * Ensure that the font is loaded by adding it to the partial `layouts/partials/fonts.html`. This partial defines the font using a style sheet and ensures that the font resources are pre-loaded. Here is an example that shows how to define the font face 'Geist Mono' with a regular font weight: ``` @font-face { font-family: 'Geist Mono'; src: url('{{ $basePath }}/fonts/GeistMono-Regular.woff2') format('woff2'); font-weight: 400; font-style: normal; font-display: swap; } ``` * Make your font available via Tailwind by adding it to the `tailwind.config.js` file. ``` module.exports = { content: ["content/**/*.md", "layouts/**/*.html", "./tailwindcss.whitelist.txt"], theme: { extend: { fontFamily: { sans: [ 'Space Grotesk', ...defaultTheme.fontFamily.sans ], mono: [ 'Space Mono', 'SF Mono', ...defaultTheme.fontFamily.mono ], monogeist: ['Geist Mono', ...defaultTheme.fontFamily.mono ], }, ... ``` * Use a `font-*` CSS class within HTML or your style sheets, whereby the `*` needs to be substituted with one of the Tailwind fonts that you defined in the Tailwind configuration file (`tailwind.config.js`). Here is an example how to use `font-monogeist` in the global CSS file `assets/css/index.css` to change the font of code blocks: ``` .prose pre > code { @apply bg-none font-monogeist; } ``` ## Troubleshooting ### NIL pointer error when rendering a section You might sometimes see the following error message: ``` nil pointer evaluating page.Page.Params ``` This happened for us when Hugo executed the `bannerText` logic, which inspected all parent pages by checking if they have a banner text set. The problem was that one of the parent folders was missing an `_index.md` file, which meant the folder couldn't be identified as a page. The solution was to add an `_index.md` file to the folder that didn't have it yet.

Cargando el README del repositorio…

Skills en este repositorio

Desarrolladores de software Analistas de garantía de calidad de software y probadores

2 categorías ocupacionales · 100% clasificado

skill

ocupación

descripción

actualizado

tce-examples

Desarrolladores de software

Create or extend tabbed code examples (TCEs) — the multi-language code blocks rendered by the clients-example shortcode. Use when a docs page needs client examples added, when auditing a command page for missing client coverage, when an example set needs a…