mkdocs.yml

# Project information
site_name: Unix / Bash training
site_author: Jacques Dainat et al.
site_url: https://mivegec.pages.ird.fr/dainat/malbec-unix/
site_description: Unix basics training
site_dir: public # When you build your site, all of the files are written to the directory assigned to the site_dir configuration option (defaults to "site")

# Repository
repo_name: 'malbec-unix'
repo_url: 'https://forge.ird.fr/mivegec/dainat/malbec-unix'
edit_uri: edit/main/docs/ # Allow to replace edit/master/docs use by default

# Configuration
theme:
  name: material
  logo: pages/images/IRD.png # logo top left page
  search_index_only: true
  include_search_page: true
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
  # - content.tabs.link
    - content.tooltips
    - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    # - navigation.sections # collapse subsections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate # remove table of content on the right side
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.snippets:
      base_path: docs
  - tables
  - toc:
      permalink: '#'

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

# Customization
extra:
#  homepage:  # Page displayed when clicking the logo
  history_buttons: false
  # --- set whole scope variables ---
  contact: jacques.dainat@ird.fr
  institute: IRD
  unit: MIVEGEC
  repo: https://forge.ird.fr/mivegec/dainat/malbec-unix
  working_directory: training_unix
  color_table_header: "#333a99"

# page tree
nav:
    - Home:
        - Introduction: index.md
        - Setup: pages/course-information/setup.md
    - Unix basics:
        - Course overview: pages/bash/bash-0-overview.md
        - Introduction: pages/bash/bash-1-introduction.md
        - The basics: pages/bash/bash-2-the-basics.md
        - Navigating files and directories: pages/bash/bash-3-navigating.md
        - Working with files and directories: pages/bash/bash-4-working_with_files_and_directories.md
        - Special_characters: pages/bash/bash-5-special_characters.md
        - PATH: pages/bash/bash-6-path.md
        - Commands: pages/bash/bash-7-commands.md
    - Unix data/file manipulation:
        - Course overview: pages/bash_manip/bash_manip-0-overview.md
        - Introduction: pages/bash_manip/bash_manip-1-introduction.md
        - Basic commands: pages/bash_manip/bash_manip-2-basics.md
        - Grep (part1): pages/bash_manip/bash_manip-3-grep.md
        - Regular expressions: pages/bash_manip/bash_manip-4-regex.md
        - Grep (part2): pages/bash_manip/bash_manip-5-grep2.md
        - Awk: pages/bash_manip/bash_manip-4-awk.md
        - Sed: pages/bash_manip/bash_manip-5-sed.md
    - Bash scripting:
        - Course overview: pages/bash_script/bash_script-0-overview.md
        - Introduction: pages/bash_script/bash_script-1-intro.md
        - Data structures: pages/bash_script/bash_script-2-data_structure.md
        - Conditional structures: pages/bash_script/bash_script-3-conditional.md
        - Loops: pages/bash_script/bash_script-4-loop.md
        - Arguments: pages/bash_script/bash_script-5-argument.md
        - Functions: pages/bash_script/bash_script-6-function.md
        - User Interface: pages/bash_script/bash_script-7-interface.md
      
    - Cheat sheet:
        - Bash Cheat sheet: pages/cheat_sheet/bash/bash.md
        - Interesting ressources: pages/cheat_sheet/interesting_ressources.md