config.toml

# The baseURL will be replaced by the build script
baseURL = "https://redis.io"
title = "Docs"

timeout="75"
refLinksErrorLevel = "WARNING"
enableRobotsTXT = true
enableGitInfo = true
enableEmoji = true

contentDir = "content/"

# ignoreErrors = ["error-remote-getcsv"]

# Stop Hugo's filesystem watcher from opening fds for build artifacts
# and language-package directories that ship inside use-case demos but
# are never referenced from a page as a resource. Without these the
# Rust `target/` and PHP `vendor/` trees alone account for ~8,500 of
# the files under `content/`, which pushes the watcher past macOS's
# default `kern.maxfilesperproc` ceiling on `hugo serve`.
ignoreFiles = [
  "/vendor/",            # composer / bundler deps
  "/node_modules/",      # npm deps
  "/target/",            # rust + maven build output
  "/bin/",               # .NET build output
  "/obj/",               # .NET intermediate output
  "/__pycache__/",       # Python bytecode cache
  "/models/",            # Hugot model cache
  "/\\.transformers-cache/",  # TransformersPHP cache
  # AI-audience convention files. These live beside the pages they describe so
  # coding agents load them by directory, but they are not documentation and must
  # never render: Hugo turns any .md under content/ into a published page.
  "AGENTS\\.md$",
  "CLAUDE\\.md$",
  "CLAUDE\\.local\\.md$",
]

[related]
[[related.indices]]
  name = 'group'
  weight = 1
  includeNewer = true

# Highlighting config
pygmentsCodeFences = false
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false

# Configure how URLs look like per section.
[permalinks]
blog = "/:section/:year/:month/:day/:slug/"

## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
[blackfriday]
plainIDAnchors = true
hrefTargetBlank = true
angledQuotes = false
latexDashes = true

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[params]
tagManagerId = "GTM-TKZ6J9R"
gitHubRepo = "https://github.com/redis/docs"

# Schema version for the AI-facing JSON and Markdown outputs. Emitted as
# `schema_version` in each per-page JSON record and in the Markdown metadata block.
#
# Increment this ONLY when the shape of a record changes: a field added, removed or
# renamed, or a new value entering the `role` vocabulary. It must NOT change when page
# content changes -- consumers gate re-parsing on it, and a version that moves with
# content is a second content hash, which they will learn to ignore.
#
# Changing what a field *contains* is not a shape change and does not bump this.
#
# History:
#   1 -- initial: sections, examples, content_hash, page_type, id, since (DOC-6939)
#   2 -- adds `aliases` to page records, and a new `page_type` value, "moved", for
#        the redirect tombstones published at a moved page's old URL. A parser
#        switching on page_type now meets a value it has not seen, and those
#        records carry a `moved_to` field, so this is a shape change (DOC-6951).
aiSchemaVersion = 2

# Display and sort order for client examples
clientsExamples = ["Python", "Node.js", "ioredis", "Java-Sync", "Lettuce-Sync", "Java-Async", "Java-Reactive", "Go", "C", "C#-Sync (NRedisStack)", "C#-Async (NRedisStack)", "C#-Sync (SE.Redis)", "C#-Async (SE.Redis)", "RedisVL", "PHP", "Ruby", "Rust-Sync", "Rust-Async"]
searchService = "/convai/api/search-service"
ratingsService = "/docusight/api/rate/docs"

# RDI params
rdi_rlec_min_version = "6.2.18"
rdi_redis_gears_version = "1.2.6"
rdi_debezium_server_version = "2.3.0.Final"
rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
rdi_cli_latest = "latest"
rdi_current_version = "1.19.1"


[params.clientsConfig]
# mappingClientId maps to keys in data/command-api-mapping.json for method signatures
"Python"={quickstartSlug="redis-py", langId="python", clientId="redis-py", clientName="redis-py", mappingClientId="redis_py"}
"Node.js"={quickstartSlug="nodejs", langId="javascript", clientId="node-redis", clientName="node-redis", mappingClientId="node_redis"}
"ioredis"={quickstartSlug="ioredis", langId="javascript", clientId="ioredis", clientName="ioredis", mappingClientId="ioredis"}
"Java-Sync"={quickstartSlug="jedis", langId="java", clientId="jedis", clientName="Jedis", mappingClientId="jedis"}
"Lettuce-Sync"={quickstartSlug="lettuce", langId="java", clientId="lettuce", clientName="Lettuce", mappingClientId="lettuce_sync"}
"Java-Async"={quickstartSlug="lettuce", langId="java", clientId="lettuce", clientName="Lettuce", mappingClientId="lettuce_async"}
"Java-Reactive"={quickstartSlug="lettuce", langId="java", clientId="lettuce", clientName="Lettuce", mappingClientId="lettuce_reactive"}
"Go"={quickstartSlug="go", langId="go", clientId="go-redis", clientName="go-redis", mappingClientId="go-redis"}
"C"={quickstartSlug="hiredis", langId="c", clientId="hiredis", clientName="hiredis", mappingClientId=""}
"C#-Sync (NRedisStack)"={quickstartSlug="dotnet", langId="csharp", clientId="nredisstack", clientName="NRedisStack", mappingClientId="nredisstack_sync"}
"C#-Async (NRedisStack)"={quickstartSlug="dotnet", langId="csharp", clientId="nredisstack", clientName="NRedisStack", mappingClientId="nredisstack_async"}
"C#-Sync (SE.Redis)"={quickstartSlug="dotnet", langId="csharp", clientId="stackexchange-redis", clientName="StackExchange.Redis", mappingClientId="nredisstack_sync"}
"C#-Async (SE.Redis)"={quickstartSlug="dotnet", langId="csharp", clientId="stackexchange-redis", clientName="StackExchange.Redis", mappingClientId="nredisstack_async"}
"RedisVL"={quickstartSlug="redis-vl", langId="python", clientId="redis-vl", clientName="RedisVL", mappingClientId="redis_vl"}
"PHP"={quickstartSlug="php", langId="php", clientId="predis", clientName="Predis", mappingClientId="php"}
"Ruby"={quickstartSlug="redis-rb", langId="ruby", clientId="redis-rb", clientName="redis-rb", mappingClientId="redis_rb"}
"Rust-Sync"={quickstartSlug="rust", langId="rust", clientId="redis-rs", clientName="redis-rs", mappingClientId="redis_rs_sync"}
"Rust-Async"={quickstartSlug="rust", langId="rust", clientId="redis-rs", clientName="redis-rs", mappingClientId="redis_rs_async"}

# Mount directories for duplicate content
[module]
[[module.mounts]]
  source = "content"
  target = "content"
[[module.mounts]]
  source = "content/operate/rs/databases/active-active/develop"
  target = "content/operate/rc/databases/active-active/develop"
  excludeFiles = ["_index.md"]

# Markup
[markup]
  [markup.goldmark]
    [markup.goldmark.renderer]
      unsafe = true
    [markup.goldmark.extensions]
      typographer = false
  [markup.highlight]
      # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
      # style = "github-dark"
      noClasses = "false"
      # Uncomment if you want your chosen highlight style used for code blocks without a specified language
      # guessSyntax = "true"

# Everything below this are Site Params

# Add markdown output
[outputFormats]
  [outputFormats.markdown]
    name = "markdown"
    baseName = "index.html"
    mediaType = "text/markdown"
    isPlainText = true

  # Add JSON output for AI/LLM consumption (per-page JSON files)
  [outputFormats.json]
    name = "json"
    baseName = "index"
    mediaType = "application/json"
    isPlainText = true

  # A site-wide map of every alias to the page it resolves to, published once on
  # the home page as /redirects.json. Rendered from `.Aliases` -- the same data
  # Hugo uses to emit its own redirect stubs -- so the map and the site's actual
  # behavior cannot drift, and there is no generated file to keep in step.
  [outputFormats.redirects]
    name = "redirects"
    baseName = "redirects"
    mediaType = "application/json"
    isPlainText = true

# Comment out if you don't want the "print entire section" link enabled.
[outputs]
section = ["HTML", "RSS", "Markdown", "JSON"]
page = ["HTML", "Markdown", "JSON"]
# The home page had no entry, so it was on Hugo's default of HTML and RSS. That
# default is reproduced here deliberately: adding Markdown or JSON would publish a
# new record for the site root, which is one of the pages the feed excludes today.
# Only the redirects map is new.
home = ["HTML", "RSS", "redirects"]