aboutsummaryrefslogtreecommitdiff
path: root/mkdocs.yml
blob: b74517b79a899320e173acf5a839af6121b6986e (plain)
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
162
163
164
165
166
167
168
169
170
#
# Mkdocs configuration
#

# Basic info
site_name: Protocolos Sociotécnicos

# Folders
docs_dir : docs
site_dir : site

# URLs
#repo_url: https://0xacab.org/rhatto/protocolos
repo_url: https://git.fluxo.info/templates
edit_uri: ''

# Development
# Site address is bind to 0.0.0.0 so it works find inside a Docker container.
# A better config would be desirable.
#dev_addr: '0.0.0.0:8040'

# Theme configuration
# See https://www.mkdocs.org/user-guide/choosing-your-theme/
#     https://squidfunk.github.io/mkdocs-material/
theme:
  name               : material
  collapse_navigation: true
  titles_only        : false
  logo               : https://fluxo.info/images/fluxo.png
  palette:
    primary: blue grey

  # Do not use external fonts
  # Usefult for offline operation
  # See https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading
  #font: false

# Extra stylesheets
extra_css:
  - site.css

# Plugins
# https://www.mkdocs.org/dev-guide/plugins/
plugins:
  # Search
  # See https://www.mkdocs.org/user-guide/configuration/#search
  #     https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
  search: {}

  # Awesome Pages Plugin
  # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
  awesome-pages:
    collapse_single_pages: true

  # The built-in privacy plugin automatically identifies external assets as
  # part of the build process and downloads all assets for very simple
  # self-hosting
  #
  # See https://squidfunk.github.io/mkdocs-material/plugins/privacy/
  #     https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#built-in-privacy-plugin
  privacy: {}

  # BibTeX support using mkdocs-bibtex
  # https://pypi.org/project/mkdocs-bibtex/
  # https://github.com/shyamd/mkdocs-bibtex
  bibtex:
    bib_dir   : "biblio"
    csl_file  : "apa.csl"
    #cite_inline: true

  # Internationalization
  i18n:
    docs_structure: suffix
    languages:
      - locale: en
        name: English
        build: true

      - locale: pt
        name: Português
        build: true
        default: true
        nav_translations:
          Provedor: Provider

  # MkDocs-Macros Plugin
  # https://mkdocs-macros-plugin.readthedocs.io
  macros: {}

  # Redirects
  # https://github.com/mkdocs/mkdocs-redirects
  # In case site re-structure is needed, this plugin will ensure permalink functionality
  #- redirects:
  #    redirect_maps:
  #      'somepage.md' : 'otherpage.md'

# Markdown extensions
# See https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
#     https://squidfunk.github.io/mkdocs-material/setup/extensions/
markdown_extensions:
  # Footnotes
  # https://squidfunk.github.io/mkdocs-material/reference/footnotes/
  footnotes: {}

  # Tasklist handling
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist
  pymdownx.tasklist:
    custom_checkbox: true

  # Admonitions
  # https://squidfunk.github.io/mkdocs-material/reference/admonitions/
  admonition: {}

  # Details
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details
  pymdownx.details: {}

# Copyright notice
copyright: Copyleft © 2024

# Extra template parameters
# https://www.mkdocs.org/user-guide/configuration/#extra
extra:
  generator: false

  metadata:
    version:
      pt: >
        Versão deste documento

      en: >
        Document version

    identifier:
      pt: >
        Identificador

      en: >
        Identifier

    original_identifier:
      pt: >
        Documento original

      en: >
        Original document

    original_version:
      pt: >
        Traduzido e adaptado da versão original em Português

      en: >
        Translated and adapted from the original Portuguese version

    trigger_warning:
      pt: >
        !!! warning "Alerta de gatilhos"

            Esta seção trata de temas sensíveis e que podem causar desconforto.

            Por outro lado, ela contém modelos de proceder cujo objetivo é
            acabar com violências e desconfortos sociais.

      en: >
        !!! warning "Trigger warning"

            This section deals with sensitive topics that may cause discomfort.

            On the other hand, it contains behavior models that can help
            end violences and social discomfort.