zensical.toml

[project.theme]
variant = "modern"
features = [
    "content.code.copy",
    "content.code.annotate",
    "search.highlight",
    "navigation.instant",
    "navigation.instant.progress",
    "navigation.tracking",
    "navigation.path",
    # "navigation.sections",
    # "navigation.tabs",
]
logo = "img/favicon.ico"
favicon = "img/favicon.ico"

[project]
site_name = "Fink/LSST Documentation"
repo_name = "fink-broker"
repo_url = "https://github.com/astrolabsoftware/fink-broker"
copyright = "Copyright &copy; 2018-26 <a href='https://fink-broker.org'>Fink team</a>."
nav = [
  { Home = "index.md" },
  { "Fink in a nutshell" = [
      { "Science Roadmap" = "broker/roadmap.md" },
      { "Technological consideration" = "broker/infrastructure.md" },
    ]},
  { "LSST alert data tips" = [
      { "From ZTF to LSST" = "data/ztf_to_lsst.md" },
      { "Photometry" = "data/photometry.md" },
      { "Alert data quality" = "data/quality.md" },
      { "Known issues" = "data/issues.md" }
    ]},
  { Science = [
      { "Fink science modules" = "science/science_modules.md" },
      { "Fink filters" = "science/filters.md" },
      { "Classification" = "science/classification.md" }
    ]},
  { Services = [
      { Overview = "services/summary.md" },
      # { "Science Portal" = [
      #     {"Search" = ""},
      #     {"Static objects" = ""},
      #     {"Solar System objects" = ""},
      # ]},
      { "REST API" = [
          # { "Cheat Sheet" = "services/api/cheatsheet.md" },
          { "Conesearch" = "services/api/conesearch.md" },
          { "Search by diaObjectId" = "services/api/diaobjectid.md" },
          { "Search by Solar System object name" = "services/api/solar_system.md" },
          { "Search by tag" = "services/api/tagsearch.md" },
          { "Resolving astronomical names" = "services/api/resolver.md" },
          { "Forced photometry" = "services/api/forced_photometry.md" },
          { "Image data" = "services/api/imagesearch.md" },
          { "Statistics" = "services/api/statistics.md" },
          { "Columns, blocks and tags definition" = "services/api/definitions.md" },
          { "Tips" = "services/api/tips.md" },
          { "Troubleshooting" = "services/api/troubleshooting.md" }
        ]},
        { "Livestream" = "services/livestream.md" },
        { "Data Transfer" = "services/data_transfer.md" },
        # { Xmatch = "" },
    ]},
  { "Developer corner" = [
      { "Source code" = "source-code.md" },
      { "Release Notes" = "release-notes.md" },
      { "Contributing" = "contributing.md" },
  #     { "fink-client" = "" },
      { "Alert schemas" = "developers/schemas.md" },
      { "Designing a science module" = "developers/science_module_tutorial.md" },
      { "Designing a filter" = "developers/filter_tutorial.md" },
  #     { "Testing Fink" = "developers/testing_fink.md" },
      # { "Connecting Fink" = [
      #     { "Fink-TOM" = "developers/external/tom_fink.md" }
      #   ]}
    ]},
  # {"Citing Fink" = ""}
]
extra_css = [
    "assets/stylesheets/extra.css",
    "https://unpkg.com/katex@0/dist/katex.min.css"
]
extra_javascript = [
    "javascripts/katex.js",
    "https://unpkg.com/katex@0/dist/katex.min.js",
    "https://unpkg.com/katex@0/dist/contrib/auto-render.min.js"
]

[project.extra.status]
new = "Recently added"

[project.markdown_extensions.admonition]
[project.markdown_extensions.tables]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.def_list]
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
[project.markdown_extensions.pymdownx.blocks.caption]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
  { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" }
]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
[project.markdown_extensions.pymdownx.tabbed.slugify]
object = "pymdownx.slugs.slugify"
kwds = { case = "lower" }
[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.snippets]


# Palette toggle for automatic mode
[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "lucide/sun-moon"
toggle.name = "Switch to light mode"
primary = "deep orange"

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

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

[project.markdown_extensions.pymdownx.arithmatex]
generic = true