mkdocs.yml

site_name: "Data science project template"
repo_url: https://github.com/JoseRZapata/data-science-project-template

theme:
  name: material
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.expand
    - navigation.path

nav:
  - 📖 Introduction: 'index.md'
  - 🛠️ Get started (💻 Local setup): 'local_setup.md'
  - 🗃️ Project structure:
    - 🗂️ Directory Hierarchy: 'directory_hierarchy.md'
    - 🗄️ Data Schema: 'data_schema.md'
  - 🔑 Setup Tokens: 'setup_tokens.md'
  - ⚙️  Pre-commit configuration: 'pre-commit.md'
  - 🚀 Github Actions:
    - Pre-commit_autoupdate: 'github_actions/gh_action_pre-commit-autoupdate.md'
  - 💻 VSCode configuration: 'vscode.md'


markdown_extensions:
  - pymdownx.snippets:
      check_paths: true
  - attr_list
  - 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.superfences
  - tables