mkdocs.yml

# Copyright (C) 2023 Hefestus
#
# This file is part of Bolinho.
#
# Bolinho is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Bolinho is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Bolinho.  If not, see <http://www.gnu.org/licenses/>.

site_name: Virote

repo_url: https://github.com/ZRafaF/virote
repo_name: zRafaF/virote

theme:
    name: material
    #logo:
    #favicon:
    palette:
        scheme: slate
        primary: blue grey
        accent: indigo

    locale: pt_BR
    language: pt-BR # lingua do mkdocs-material

    features:
        - navigation.sections
        - navigation.tabs
        - navigation.tabs.sticky #Faz com que a navigation tab esteja sempre visivel
        - navigation.top
        - navigation.tracking
        - navigation.path
        - navigation.indexes
        - navigation.footer
        - search.highlight
        - search.share
        - search.suggest
        - toc.follow
        - content.code.copy
        # - content.tabs.link           # Para criar Tabs de código
    icon:
        admonition:
            admonition-windows: simple/windows
            admonition-linux: simple/linux
            admonition-raspi: simple/raspberrypi
            admonition-pc: fontawesome/solid/computer
            return: material/keyboard-return

#docs_dir: 'docsSrc'
#site_dir: 'docs'

extra_css:
    - stylesheets/extra.css
    - stylesheets/pygments.css

plugins:
    - search:
          separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
    - with-pdf:
          author: Rafael F. Meneses
          cover_subtitle: Aplicativo para criação de missões de UAVs
          copyright: Copyright &copy; 2023 Rafael F. Meneses.
          toc_title: Tabela de conteúdos
          enabled_if_env: ENABLE_PDF_EXPORT
          toc_level: 2
          # two_columns_level: 3                # Exporta o PDF como duas colunas
          #custom_template_path: docs/styles.scss
          #render_js: true
    - pdf-export:
          enabled_if_env: ENABLE_PDF_EXPORT

markdown_extensions:
    - pymdownx.highlight:
          anchor_linenums: true
          use_pygments: true # Renderiza todos os códigos durante a build ao inves de no runtime
          auto_title: true
    - codehilite

    #- pymdownx.tabbed:         # Para criar Tabs de código
    #    alternate_style: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - admonition
    - pymdownx.details
    - pymdownx.superfences:
          custom_fences:
              - name: mermaid
                class: mermaid
                format: !!python/name:pymdownx.superfences.fence_code_format
    - pymdownx.critic
    - pymdownx.caret
    - pymdownx.keys
    - pymdownx.mark
    - pymdownx.tilde
    - attr_list
    - pymdownx.emoji:
          emoji_index: !!python/name:materialx.emoji.twemoji
          emoji_generator: !!python/name:materialx.emoji.to_svg
    - toc:
          permalink: true

nav:
    - Home:
          - Home: index.md
    - Front end:
          - Front end: front-end/index.md
          - Mapas: front-end/mapas.md
          - Styling: front-end/styling.md
    - Backend:
          - Backend: backend/index.md
          - Funções expostas: backend/funcoes-expostas.md
    - Sobre:
          - Sobre: sobre/index.md