pyCFM/mkdocs.yml at main · michelmetran/pyCFM · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
# Basic
site_name: pyCFM
site_author: Michel Metran
site_description: Obtem dados de médicos acessando informações do Conselho Federal de Medicina usando python!
#site_url: https://pyESAJ.readthedocs.io/
#site_url: https://pyesaj.readthedocs.io/pt/latest/
site_url: https://pycfm.readthedocs.io/
copyright: |
  &copy; 2025 <a href="https://github.com/michelmetran"  target="_blank" rel="noopener">Michel Metran</a>

# GitHub Repo Link
repo_url: https://github.com/michelmetran/pyCFM

docs_dir: "docs" # Default docs
site_dir: "site" # Default site

# NavBar
# Opcional
nav:
  - Home: index.md
  - Como Instalar?: pages/como-instalar.md
  - Como Usar?:
      - Busca Médico: scripts/busca_medicos.ipynb
      - Listas: scripts/listas.ipynb
  #     - Navegador/Driver: scripts/driver.ipynb
  #     - Login: scripts/login.ipynb
  #     - Dados Cadastrais: scripts/cadastro.ipynb
  #     - Gerenciamento de Perfil: scripts/gerenciamento_perfil.ipynb
  #     - Consulta de Processos: scripts/consulta_processo.ipynb
  # - Histórico: pages/histórico.md
  - Como Contribuir?: pages/como-contribuir.md
  # - Page Object Model: pages/pacote.md
  # - Bugs: pages/bugs.md
  # - Intimações: pages/intimações.md
  - Me, Myself and I: pages/autor.md

theme:
  # Breadcrumbs
  features:
    - navigation.path
    - navigation.top
    #- navigation.tabs
    - navigation.sections
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.footer
    - search.suggest
    - search.highlight
    - toc.follow
    #- toc.integrate
    - content.code.annotation
    - content.code.copy

  language: pt-BR

  icon:
    repo: fontawesome/brands/github
    favicon: attachment/favicon-32x32.png

  name: material
  custom_dir: docs/overrides
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: green
      accent: indigo
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

# https://facelessuser.github.io/pymdown-extensions/
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji # Suporte a emojis
  - pymdownx.tasklist # Suporte à tarefas
  - pymdownx.mark # Marcado
  - pymdownx.tilde # Realçado
  - pymdownx.highlight # Código
  #  - pymdownx.superfences:
  #      custom_fences:
  #        - name: mermaid
  #          class: mermaid
  #          format: !!python/name:pymdownx.superfences.fence_code_format
  #            # Referências
  #            # https://github.com/facelessuser/pymdown-extensions/blob/main/docs/src/mkdocs.yml

  - toc:
      permalink: true
      separator: "_"

plugins:
  - search:
      lang: pt
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'

  - tags:
      tags_slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
      tags_slugify_format: "tag:{slug}"
      tags_hierarchy: true

  - social:
      #cards_layout: default
      cards_layout_options:
        background_color: "#ff1493"
        background_image: docs/assets/bug-paginacao.png
        color: "#ffffff"
        #font_family: Ubuntu
        # logo: docs/assets/logo.png
        #title: My custom title

  #- projects
  - mkdocs-jupyter:
      ignore_h1_titles: True
      include_source: True
      execute: false
      show_input: True # Default True
      no_input: False # Default False
      #ignore: [ '1*.ipynb' ]
      include: ["*.ipynb"] # Default: ["*.py", "*.ipynb"]
      remove_tag_config:
        remove_cell_tags:
          - hide_code

extra:
  analytics:
    provider: google
    property: GT-PZVTRDZX

  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/michelmetran
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/michelmetran/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/michelmetran

  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/#versioning
  version:
    provider: mike