site_name: Jedis

repo_name: Jedis

site_author: Redis, Inc.

site_description: Jedis is a Redis client for the JVM.

repo_url: https://github.com/redis/jedis

remote_branch: gh-pages

theme:

name: material

logo: assets/images/logo.png

favicon: assets/images/favicon-16x16.png

extra_css:

- css/extra.css

plugins:

- search

- macros:

include_dir: .

markdown_extensions:

- pymdownx.highlight:

anchor_linenums: true

line_spans: __span

pygments_lang_class: true

- pymdownx.inlinehilite

- pymdownx.snippets

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- admonition

- pymdownx.details

nav:

- Home: index.md

- Jedis Maven: jedis-maven.md

- User Guide:

- Transactions/Multi: transactions-multi.md

- Hash Import (HIMPORT): hash-import.md

- Smart Client Handoffs: smart-client-handoffs.md

- Release Notes:

- 8.1.0: release-notes/8.1.0.md

- Migrating to newer versions:

- Jedis 8: migration-guides/v7-to-v8.md

- Jedis 7: migration-guides/v6-to-v7.md

- Jedis 6: migration-guides/v5-to-v6.md

- Jedis 5: migration-guides/v4-to-v5.md

- Jedis 4:

- Breaking changes: migration-guides/v3-to-v4.md

- Primitives: migration-guides/v3-to-v4-primitives.md

- ZSET: migration-guides/v3-to-v4-zset-list.md

- Using Jedis with ...:

- Search: redisearch.md

- JSON: redisjson.md

- Failover: failover.md

- Verifying artifacts: verifying-artifacts.md

- FAQ: faq.md

- API Reference: https://www.javadoc.io/doc/redis.clients/jedis/latest/index.html

- Tutorials and Examples: tutorials_examples.md

- Jedis Guide: https://redis.io/docs/latest/develop/connect/clients/java/jedis/

- Redis Command Reference: https://redis.io/docs/latest/commands/

- Advanced Usage: advanced-usage.md

- Development guide:

- Contributing: .github/CONTRIBUTING.md

- Integration Testing: integration-testing.md

- Redis Client Components Overview: redis-client-components-overview.md

- Release Process: release-process.md

- Benchmark results: https://redis.github.io/jedis/benchmarks/