zensical.toml

# Generated by `zensical new` 0.0.63, then adapted. Reference: https://zensical.org/docs/setup/basics/
[project]
site_url = "https://openjavaformat.dev/"
site_name = "open-java-format"
site_description = "A deterministic, lambda-friendly formatter for Java code: one style, 120-character lines, nothing to tune, built in the open."
# site_author = "Your name"

# copyright = "Copyright © 2026 Your name"

# The header links to the formatter, while "Edit this page" must open this site's own sources.
# An absolute edit_uri is the documented way to split the two:
# https://zensical.org/docs/setup/repository/#edit_uri
repo_url = "https://github.com/openjavaformat/open-java-format"
repo_name = "openjavaformat/open-java-format"
edit_uri = "https://github.com/openjavaformat/docs/edit/main/docs/"

nav = [
  { "Home" = "index.md" },
  { "Get started" = [
    "get-started/index.md",
    { "Gradle plugin" = "get-started/gradle.md" },
    { "Spotless" = "get-started/spotless.md" },
    { "Maven plugin" = "get-started/maven.md" },
    { "Command line" = "get-started/command-line.md" },
    { "IntelliJ IDEA" = "get-started/intellij-idea.md" },
    { "Eclipse" = "get-started/eclipse.md" },
    { "GitHub Action and pre-commit" = "get-started/github-actions.md" },
  ] },
  { "AI agents" = "ai-agents.md" },
  { "Style" = "style.md" },
  { "Library rules" = [
    "library-rules/index.md",
    { "Flogger" = "library-rules/flogger.md" },
  ] },
  { "Migrate" = "migrate.md" },
  { "Manifesto" = "manifesto.md" },
  { "About" = "about.md" },
]

# extra_css = ["stylesheets/extra.css"]
# extra_javascript = ["javascripts/extra.js"]

[project.theme]
# variant = "classic"
custom_dir = "overrides"
favicon = "assets/favicon.svg"
language = "en"
# System fonts only, so that a page view makes no request to Google Fonts.
# https://zensical.org/docs/setup/fonts/#autoloading
font = false
features = [
  "announce.dismiss",
  "content.action.edit",
  "content.action.view",
  "content.code.annotate",
  "content.code.copy",
  "content.code.select",
  "content.footnote.tooltips",
  "content.tabs.link",
  "content.tooltips",
  # "header.autohide",
  # "navigation.expand",
  "navigation.footer",
  "navigation.indexes",
  "navigation.instant",
  "navigation.instant.prefetch",
  # "navigation.instant.progress",
  "navigation.path",
  # "navigation.prune",
  "navigation.sections",
  "navigation.tabs",
  # "navigation.tabs.sticky",
  "navigation.top",
  "navigation.tracking",
  "search.highlight",
  # "toc.follow",
  # "toc.integrate",
]

# logo = "assets/logo.png"

# The project mark, inlined from overrides/.icons so it inherits the header colour in both schemes.
# https://zensical.org/docs/setup/logo-and-icons/#additional-icons
[project.theme.icon]
logo = "ojf/logo"
repo = "fontawesome/brands/github"

[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "lucide/sun-moon"
toggle.name = "Switch to light mode"

[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to system preference"

# The formatter version that the pages install. A page writes it as {{ ojf_version }}, and the macros
# plugin puts it in before the Markdown is rendered, so it lands in code blocks too. The key is not
# extra.version: the theme reads that one as the switch for a version selector.
[project.extra]
ojf_version = "2.98.0.4"
# The Maven plugin is released from its own repository, openjavaformat/fmt-maven-plugin, with version
# numbers of its own. Bump it on each release of the plugin.
maven_plugin_version = "2.27.0.1"

# Renders every page as a Jinja template, for {{ ojf_version }}. A misspelt variable or a stray {{
# fails the build instead of leaving a gap or the raw text on the site.
# https://zensical.org/docs/compatibility/mkdocs/plugins/#macros
[project.plugins.macros]
on_undefined = "strict"
on_error_fail = true

# [[project.extra.social]]
# icon = "fontawesome/brands/github"
# link = "https://github.com/user/repo"

# [[project.extra.social]]
# icon = "fontawesome/brands/mastodon"
# link = "https://fosstodon.org/@user"

[project.markdown_extensions]
abbr = {}
admonition = {}
attr_list = {}
def_list = {}
footnotes = {}
md_in_html = {}
toc.permalink = true
pymdownx.arithmatex.generic = true
pymdownx.betterem = {}
pymdownx.caret = {}
pymdownx.details = {}
pymdownx.emoji.emoji_generator = "zensical.extensions.emoji.to_svg"
pymdownx.emoji.emoji_index = "zensical.extensions.emoji.twemoji"
pymdownx.highlight.anchor_linenums = true
pymdownx.highlight.line_spans = "__span"
pymdownx.highlight.pygments_lang_class = true
pymdownx.inlinehilite = {}
pymdownx.keys = {}
pymdownx.magiclink = {}
pymdownx.mark = {}
pymdownx.smartsymbols = {}
# pymdownx.snippets.base_path = "includes"
pymdownx.superfences.custom_fences = [
  { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]
pymdownx.tabbed.alternate_style = true
pymdownx.tabbed.combine_header_slug = true
pymdownx.tasklist.custom_checkbox = true
pymdownx.tilde = {}