mkdocs.yml

site_name: Netmikro Documentation
site_url: https://netmikro.henriquesebastiao.com/
repo_url: https://github.com/henriquesebastiao/netmikro
repo_name: henriquesebastiao/netmikro

copyright: 2024 - Henrique Sebastião

nav:
  - Netmikro: index.md
  - API reference:
      - RouterOS: api/routeros.md
      - Base: api/base.md
      - IP: api/ip.md
      - System: api/system.md
  - Outros:
      - Validadores: others/validators.md
  - Estrutura: structure.md
  - Contributing: contributing.md

theme:
  name: material
  logo: assets/netmikro.png
  favicon: assets/netmikro.png
  font:
    text: Roboto
    code: Source Code Pro
  icon:
    repo: fontawesome/brands/github-alt
  palette:
    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

    # Palette toggle for light mode
    - scheme: default
      primary: black
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
  features:
    - search.suggest
    - search.share
    - announce.dismiss
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.expand
    - navigation.path
    - toc.follow
    - navigation.top
    - navigation.footer
    - content.code.annotate

markdown_extensions:
  - toc:
      permalink: true
  - markdown.extensions.codehilite:
      guess_lang: false
  - admonition
  - attr_list
  - tables
  - codehilite
  - extra
  - pymdownx.inlinehilite
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format ''
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: [netmikro]
          options:
            docstring_style: google
  - macros
  - search
  - git-authors
  - git-committers:
      repository: henriquesebastiao/netmikro
      branch: main
      token: !ENV ["GH_TOKEN"]
  - git-revision-date-localized:
      type: date

extra:
  variables:
    version: 0.1.0
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/henriquesebastiao/netmikro
      name: github.com/henriquesebastiao
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/hick_hs
      name: hick_hs on Twitter
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/henriquesebastiao
      name: Henrique Sebastião
    - icon: fontawesome/solid/envelope
      link: mailto:<contato@henriquesebastiao.com>
      name: contato@henriquesebastiao.com
    - icon: fontawesome/solid/globe
      link: https://henriquesebastiao.com
      name: henriquesebastiao.com

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

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