aboutsummaryrefslogtreecommitdiff
path: root/mkdocs.yml
blob: e96188e9406c1c988306ed7be3e6e2b55a1d9f2c (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
#
# Mkdocs configuration
#

site_name: Copy Far "AI"
docs_dir : docs
site_dir : public
dev_addr : '127.0.0.1:8070'
repo_url : https://0xacab.org/copyfarai/copyfarai.itcouldbewor.se
edit_uri : edit/main/docs/

# 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:8070'

theme:
  #features:
  #  - content.action.edit

  name               : material
  collapse_navigation: true
  titles_only        : false
  palette:

    # Palette toggle for light mode
    - scheme: default
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

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

extra_css:
  - site.css

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

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

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

  # MkDocs static i18n plugin
  # https://github.com/ultrabug/mkdocs-static-i18n
  i18n:
      docs_structure: suffix
      languages:
        - locale: en
          name: English
          build: true
          default: true
        - locale: pt
          name: Português
          build: true
          nav_translations:
            Flavors: Sabores
            Versions: Versões

  # mkdocs-redirects
  # https://github.com/mkdocs/mkdocs-redirects
  # In case site re-structure is needed, this plugin will ensure permalink functionality
  #redirects:
  #  redirect_maps:
  #    'flavors/CC-BY-NC-SA-4.0-FAI.en.md' : variants/CC-BY-NC-SA-4.0-FAI.en.md
  #    'flavors/CC-BY-4.0-FAI.en.md'       : variants/CC-BY-4.0-FAI.en.md
  #    'flavors/CC-BY-4.0-FAI.pt.md'       : variants/CC-BY-4.0-FAI.pt.md
  #    'flavors/CC-BY-NC-SA-4.0-FAI.pt.md' : variants/CC-BY-NC-SA-4.0-FAI.pt.md
  #    'flavors/CC-BY-SA-4.0-FAI.en.md'    : variants/CC-BY-SA-4.0-FAI.en.md
  #    'flavors/CC-BY-SA-4.0-FAI.pt.md'    : variants/CC-BY-SA-4.0-FAI.pt.md

  # 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: {}

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

# Copyright notice
copyright: Copy Far "AI" 🄯 2023+

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

  base_url: https://copyfarai.itcouldbewor.se

  slogan:
    en: A license close to copyleft and far from the so-called "Artificial Intelligences"
    pt: Uma licença próxima do copyleft e longe das ditas "Inteligências Artificiais"

  licenses:
    v0_0_1:
      en: >
        This work, in the present or previous versions, cannot be used for
        procedures known as "machine learning" and stylometric analysis
        without the previous authorization. For all other uses, this
        version is available under the License

      pt: >
        Esta obra, na presente versão assim como nas anteriores, não pode
        ser usada para procedimentos conhecidos como "treinamento ou
        aprendizado de máquina" e análise estilométrica sem a prévia
        autorização. Para todos os outros meios e fins, esta versão está
        disponível sob a Licença