mkdocs.yml

site_name: SLMCode
site_description: Premium coding harness for SLMs — fun docs, serious loop, any OpenAI-compatible LLM ☀️
site_author: UnicoLab
site_url: https://unicolab.github.io/smlcode/
repo_name: UnicoLab/smlcode
repo_url: https://github.com/UnicoLab/smlcode
edit_uri: edit/main/docs/
copyright: ☀️ Made with ♥ by <a href="https://unicolab.ai" target="_blank" rel="noopener">UnicoLab</a> · MIT License · go make doctor green

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/slmcode-logo.png
  favicon: assets/slmcode-logo.png
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to system preference
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  features:
    - announce.dismiss
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
    - content.tooltips
    - toc.follow
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil-outline
    admonition:
      tip: material/lightbulb-on-outline
      note: material/information-outline
      warning: material/alert-outline
      danger: material/fire
      success: material/check-decagram

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true

extra:
  homepage: https://unicolab.github.io/smlcode/
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/UnicoLab/smlcode
      name: GitHub
    - icon: fontawesome/solid/heart
      link: https://unicolab.ai
      name: UnicoLab
    - icon: fontawesome/solid/box-open
      link: https://github.com/UnicoLab/smlcode/releases
      name: Releases
  generator: false
  status:
    new: Recently added
    deprecated: Deprecated

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

nav:
  - 🏠 Home: index.md
  - 🚀 Getting started:
      - 📦 Install: install.md
      - 🔒 Offline install: install-offline.md
      - ⏱️ Quick start: quickstart.md
      - 🧠 Concepts: concepts.md
      - 🔌 Providers: providers.md
  - 📘 Handbook:
      - 🧭 User guide: guide.md
      - 🖥️ TUI & chat: tui.md
      - 🎨 Studio: studio.md
      - 🦋 Skills: skills.md
      - 🧩 Agents: agents.md
      - 👥 Teams: squads.md
      - 🎨 Frontend: frontend.md
      - 🧱 Blocks: blocks.md
      - 🏭 Pipeline: pipeline.md
      - 🛠️ Customization: customization.md
      - 🧪 Recipes: recipes.md
  - 📚 Reference:
      - ⌨️ CLI: cli.md
      - ⚙️ Config: config.md
      - 📏 Calibration: calibration.md
      - 📊 SLM learnings: slm-learnings.md
      - 🧰 Tools (ACI): tools.md
      - 🔒 Constrained decoding: decoding.md
      - 📐 Context engineering: context.md
      - 🛡️ Permissions & safety: permissions.md
      - ✅ Testing: testing.md
      - 🩺 Troubleshooting: troubleshooting.md
      - ❓ FAQ: faq.md
  - 🔧 Internals:
      - 🏗️ Architecture: architecture.md
      - 🧭 Conventions: conventions.md
      - 🧬 Self-improvement & memory: self-improvement.md
      - 🕸️ Knowledge graph: graph.md
      - 🔬 Autoresearch: autoresearch.md
  - 💚 Project:
      - 🚚 Migration notes: migration.md
      - 📝 Changelog: changelog.md
      - 🤝 Contributing: contributing.md