mkdocs.yml

site_name: FastAPI-fastkit
site_description: Fast, easy-to-use starter kit for new users of Python and FastAPI
site_url: https://bnbong.github.io/FastAPI-fastkit/
repo_name: bnbong/FastAPI-fastkit
repo_url: https://github.com/bnbong/FastAPI-fastkit
theme:
  custom_dir: overrides
  name: material
  font:
    text: JetBrains Mono
  # Light and Dark Theme Toggle
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: brown
      toggle:
        icon: material/brightness-7  # current mode : light
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: brown
      toggle:
        icon: material/brightness-4  # current mode : dark
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.footer
    - navigation.top
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - search.highlight
    - search.share
    - search.suggest
    - announce.dismiss
    - toc.follow
  logo: img/FastAPI-fastkit_logo.png
  favicon: img/FastAPI-fastkit_logo.png
  language: en
plugins:
  # Material for MkDocs
  - search
  # Multi-language support
  - i18n:
      docs_structure: folder
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: ko
          name: 한국어
          build: true
          nav_translations:
            Home: 홈
            User Guide: 사용자 가이드
            Tutorial: 튜토리얼
            Contributing: 기여하기
            Reference: 레퍼런스
            Changelog: 변경 로그
        - locale: ja
          name: 日本語
          build: true
          nav_translations:
            Home: ホーム
            User Guide: ユーザーガイド
            Tutorial: チュートリアル
            Contributing: 貢献
            Reference: リファレンス
            Changelog: 変更履歴
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 首页
            User Guide: 用户指南
            Tutorial: 教程
            Contributing: 贡献
            Reference: 参考
            Changelog: 更新日志
        - locale: es
          name: Español
          build: true
          nav_translations:
            Home: Inicio
            User Guide: Guía del Usuario
            Tutorial: Tutorial
            Contributing: Contribuir
            Reference: Referencia
            Changelog: Registro de Cambios
        - locale: fr
          name: Français
          build: true
          nav_translations:
            Home: Accueil
            User Guide: Guide de l'Utilisateur
            Tutorial: Tutoriel
            Contributing: Contribuer
            Reference: Référence
            Changelog: Journal des Modifications
        - locale: de
          name: Deutsch
          build: true
          nav_translations:
            Home: Startseite
            User Guide: Benutzerhandbuch
            Tutorial: Tutorial
            Contributing: Beitragen
            Reference: Referenz
            Changelog: Änderungsprotokoll

nav:
  - Home: index.md
  - User Guide:
    - Installation: user-guide/installation.md
    - Quick Start: user-guide/quick-start.md
    - Creating Projects: user-guide/creating-projects.md
    - Adding Routes: user-guide/adding-routes.md
    - Using Templates: user-guide/using-templates.md
    - CLI Reference: user-guide/cli-reference.md
  - Tutorial:
    - Getting Started: tutorial/getting-started.md
    - Your First Project: tutorial/first-project.md
    - Implementing Basic API Server: tutorial/basic-api-server.md
    - Implementing Asynchronous CRUD API: tutorial/async-crud-api.md
    - Database Integration: tutorial/database-integration.md
    - Docker Deployment: tutorial/docker-deployment.md
    - Implementing Custom Response Handling: tutorial/custom-response-handling.md
    - Implementing MCP Server: tutorial/mcp-integration.md
  - Contributing:
    - Development Setup: contributing/development-setup.md
    - Code Guidelines: contributing/code-guidelines.md
    - Template Creation Guide: contributing/template-creation-guide.md
    - Translation Guide: contributing/translation-guide.md
  - Reference:
    - FAQ: reference/faq.md
    - Template Quality Assurance: reference/template-quality-assurance.md
  - Changelog: changelog.md

markdown_extensions:
  # Python Markdown
  - abbr
  - attr_list
  - footnotes
  - md_in_html
  - mdx_include
  - admonition
  - pymdownx.details
  # PyMdown Extensions
  - pymdownx.highlight:  # necessary for code blocks & termynal
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite  # necessary for code blocks & termynal
  - pymdownx.snippets  # necessary for code blocks & termynal
  - pymdownx.superfences  # necessary for code blocks & termynal

extra_css:
  - css/termynal.css
  - css/custom.css

extra_javascript:
  - js/termynal.js
  - js/custom.js