pandora/mkdocs.yml at main · DatLabUFABC/pandora · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# Informações do projeto
site_name: pandora
site_url: https://github.com/ThiagoPanini/pandora
site_author: Thiago Panini
site_description: >-
  Funcionalidades relevantes para uso em aplicações construídas
  e executadas em ambientes de cloud

# Repositório
repo_name: ThiagoPanini/pandora
repo_url: https://github.com/ThiagoPanini/pandora

# Copyright
copyright: |
  Copyright &copy; 2023 <a href="https://github.com/ThiagoPanini"  target="_blank" rel="noopener">ThiagoPanini</a>

# Definindo diretório de páginas em markdown
docs_dir: docs/mkdocs

# Configuração do tema
theme:
  name: material

  # Apontando diretório adicional para customizações
  custom_dir: docs/assets

  # Definindo ícone customizado no header
  icon:
    logo: custom/custom-icon

  # Definindo paleta de cores nas versões "Dia" e "Noite"
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Clique para alterar para modo noturno
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Clique para alterar para modo claro

  # Definindo features do template
  features:
    - navigation.tabs
    - navigation.top
    - navigation.instant
    - navigation.footer
    - navigation.indexes
    - content.tabs.link
    - content.tooltips
    - search.share
    - search.highlight
    - search.suggest
    - content.code.copy

# Configurando navegação
nav:
  - Home:
    - Pandora: index.md
    - Motivadores: motivadores.md
  - Quickstart:
    - Primeiros Passos: quickstart/inicio.md
  - Repositório:
    - Visão Geral: repo/repo.md
    - Diretório .github: repo/github.md
    - Diretório docs: repo/docs.md
    - Diretório package-name: repo/pkgname.md
    - Diretório requirements: repo/requirements.md

# Extensões do MkDocs
markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - footnotes
  - markdown.extensions.tables
  - markdown.extensions.footnotes
  - attr_list
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons

# Definindo customizações personalizadas
extra_css:
  - stylesheets/extra.css

# Definindo plugins
plugins:
  - mkdocstrings