mkdocs.yml

site_name: AIS1003 E-book
site_description: Course e-book for AIS1003 — Object-Oriented Programming with C++
site_url: https://markaren.github.io/E-book_cpp/
repo_url: https://github.com/markaren/E-book_cpp
repo_name: markaren/E-book_cpp
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  features:
    - navigation.tracking
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: nb
          name: Norsk (bokmål)
          build: true
          nav_translations:
            Home: Hjem
            Getting Started: Kom i gang
            Computer Basics: Datamaskingrunnlag
            "1. Introduction": "1. Introduksjon"
            Introduction: Introduksjon
            Basic Structure: Grunnstruktur
            Variables and Basic Types: Variabler og grunntyper
            Operators and Expressions: Operatorer og uttrykk
            Strings and Vectors: Strenger og vektorer
            Control Statements: Kontrollstrukturer
            Functions: Funksjoner
            Enumerations: Enumerasjoner
            Exercises: Oppgaver
            "2. Tooling": "2. Verktøy"
            CMake Introduction: CMake-introduksjon
            Version Control & Git: Versjonskontroll og Git
            "3. Standard Library & Data Structures": "3. Standardbibliotek og datastrukturer"
            C++ Standard Library: C++ standardbibliotek
            Data Structures: Datastrukturer
            "4. Classes & Types": "4. Klasser og typer"
            Classes: Klasser
            Values, References & Pointers: Verdier, referanser og pekere
            IO & Streams: IO og strømmer
            "5. Memory & Polymorphism": "5. Minne og polymorfisme"
            Memory Management: Minnehåndtering
            Move Semantics: Flyttesemantikk
            Polymorphism: Polymorfisme
            Templates: Maler
            "6. Design & Quality": "6. Design og kvalitet"
            Separation of Concerns: Separasjon av ansvar
            Observer Pattern: Observatør-mønsteret
            Error Handling: Feilhåndtering
            Testing: Testing
            Tank Control System: Tankreguleringssystem
            "Version 1 — Classes & Loop": "Versjon 1 — Klasser og løkke"
            "Version 2 — Sensors & Polymorphism": "Versjon 2 — Sensorer og polymorfisme"
            "Version 3 — PID & Composition": "Versjon 3 — PID og komposisjon"
            "Version 4 — A Real Project": "Versjon 4 — Et ekte prosjekt"
            "Version 5 — Tests": "Versjon 5 — Tester"
            Capstone Project: Prosjekt
            Reference: Referanse
            Coming from Python: Fra Python
            Arduino vs. Desktop C++: Arduino vs. desktop-C++
            Portability: Portabilitet
            Reading Compiler Errors: Lese kompilatorfeil
            Using a Debugger: Bruke en debugger
            Using AI for Coding: Bruke KI til koding
            Code Style: Kodestil
            The README: README-fila
            UML Diagrams: UML-diagrammer
            Strings: Strenger
            Lambda Expressions: Lambda-uttrykk
            Recursion: Rekursjon
            Building a Tree: Bygge et tre
            Floating-Point Pitfalls: Flyttall-fallgruver
            Random Numbers: Tilfeldige tall
            Common Terms: Vanlige begreper
            FAQ: Ofte stilte spørsmål

hooks:
  - hooks/compiler_explorer.py

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/spoiler.js

nav:
  - Home: index.md
  - Getting Started:
    - getting_started.md
    - Computer Basics: computer_basics.md
  - 1. Introduction:
    - Introduction: Chapter1/introduction.md
    - Basic Structure: Chapter1/basic_structure.md
    - Variables and Basic Types: Chapter1/variables.md
    - Operators and Expressions: Chapter1/operators_expressions.md
    - Strings and Vectors: Chapter1/strings_and_vectors.md
    - Control Statements: Chapter1/control_statements.md
    - Functions: Chapter1/functions.md
    - Enumerations: Chapter1/enums.md
    - Exercises: Chapter1/exercises.md
  - 2. Tooling:
    - CMake Introduction: Chapter2/cmake_intro.md
    - Version Control & Git: Chapter2/version_control.md
    - PlatformIO: Chapter2/platformio.md
    - Exercises: Chapter2/exercises.md
  - 3. Standard Library & Data Structures:
    - C++ Standard Library: Chapter3/standard_library.md
    - Data Structures: Chapter3/data_structures.md
    - Strings: strings.md
    - Lambda Expressions: lambdas.md
    - Exercises: Chapter3/exercises.md
  - 4. Classes & Types:
    - Classes: Chapter4/classes.md
    - Values, References & Pointers: Chapter4/types_refs_ptrs.md
    - RAII: Chapter4/raii.md
    - IO & Streams: Chapter4/io_streams.md
    - Exercises: Chapter4/exercises.md
  - 5. Memory & Polymorphism:
    - Memory Management: Chapter5/memory.md
    - Move Semantics: Chapter5/move.md
    - Polymorphism: Chapter5/polymorphism.md
    - Templates: Chapter5/templates.md
    - Exercises: Chapter5/exercises.md
  - 6. Design & Quality:
    - Separation of Concerns: Chapter6/soc.md
    - Observer Pattern: Chapter6/observer.md
    - Error Handling: Chapter6/error_handling.md
    - Testing: Chapter6/testing.md
    - Exercises: Chapter6/exercises.md
  - Tank Control System:
    - Version 1 — Classes & Loop: tank_control/v1_classes.md
    - Version 2 — Sensors & Polymorphism: tank_control/v2_sensors.md
    - Version 3 — PID & Composition: tank_control/v3_pid.md
    - Version 4 — A Real Project: tank_control/v4_project.md
    - Version 5 — Tests: tank_control/v5_tests.md
  - Capstone Project: capstone.md
  - Reference:
    - Coming from Python: python_to_cpp.md
    - Arduino vs. Desktop C++: arduino_vs_desktop.md
    - Portability: portability.md
    - Reading Compiler Errors: compiler_errors.md
    - Using a Debugger: debugger.md
    - Using AI for Coding: using_ai.md
    - Code Style: style.md
    - The README: readme_guide.md
    - UML Diagrams: uml.md
    - Recursion: recursion.md
    - Building a Tree: building_a_tree.md
    - Floating-Point Pitfalls: floating_point.md
    - Random Numbers: random.md
    - Common Terms: terms.md
    - FAQ: faq.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/markaren/E-book_cpp
  generator: false

copyright: >
  Released under the MIT License.