mkdocs.yml

site_name: marimo mkdocs
site_url: https://marimo-team.github.io/mkdocs-marimo
site_author: marimo team
site_description: mk

repo_name: mkdocs-marimo
repo_url: https://github.com/marimo-team/mkdocs-marimo

docs_dir: docs/
copyright: '2024 Marimo Team'

theme:
  name: material
  font: false
  logo: assets/android-chrome-192x192.png
  favicon: assets/favicon.ico
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - content.code.annotate
    - toc.integrate
    - toc.follow
    - navigation.path
    - navigation.top
    - content.code.copy
    - content.tabs.link
  palette:
    # Palette toggle for automatic mode
    - media: '(prefers-color-scheme)'
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

nav:
  - Overview: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
      - Configuration: getting-started/configuration.md
      - Inline Notebook: getting-started/inline-notebook.md
      - Notebooks in Navigation: getting-started/nav_notebook.py

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/marimo-team/marimo
      name: marimo on GitHub
    - icon: fontawesome/brands/discord
      link: https://marimo.io/discord
      name: marimo on Discord
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/marimo_io
      name: marimo on Twitter
plugins:
  - search
  - marimo:
      marimo_version: '0.9.12'

watch:
  - mkdocs_marimo

# hooks:
#   - mkdocs_marimo/plugin.py

markdown_extensions:
  - admonition
  - pymdownx.details
  - toc:
      anchorlink: true
      anchorlink_class: 'toclink'
  - pymdownx.snippets:
  - pymdownx.magiclink:
  - attr_list:
  - md_in_html:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite:
  - pymdownx.superfences:
  - markdown.extensions.attr_list:
  - pymdownx.keys:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tabbed:
      alternate_style: true

validation:
  nav:
    omitted_files: warn
    not_found: warn
    absolute_links: warn
  links:
    not_found: warn
    anchors: warn
    absolute_links: warn
    unrecognized_links: warn