software-engineering/mkdocs.yml at main · uselessscat/software-engineering · 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
site_name: Software Engineering
site_url: https://uselessscat.github.io/software-engineering/
repo_url: https://github.com/uselessscat/software-engineering
edit_uri: edit/main/docs/

docs_dir: docs

watch:
  - docs
  - overrides

theme:
  name: material
  custom_dir: overrides
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.select
    - content.footer.last-updated
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - search.highlight

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - awesome-pages
  - i18n:
      docs_structure: folder
      fallback_to_default: false
      languages:
        - locale: es
          name: Español
          default: true
        - locale: en
          name: English
  - strip-number-prefix:
      pattern: "^\\d+-"
      strict: true
      strip_links: false
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
#  - kroki:
#      ServerURL: http://localhost:8001
#      FileTypes:
#        - svg
#      TagFormat: svg
#      HttpMethod: POST
#  - with-pdf
  - pagetree
  - search

extra_javascript:
  - https://cdn.jsdelivr.net/npm/katex@0.16.25/dist/katex.min.js
  - https://cdn.jsdelivr.net/npm/katex@0.16.25/dist/contrib/auto-render.min.js
  - https://cdn.jsdelivr.net/npm/@panzoom/panzoom@4.6.0/dist/panzoom.min.js
  - assets/javascripts/katex-init.js
#  - js/kroki-viewer.js

extra_css:
  - https://cdn.jsdelivr.net/npm/katex@0.16.25/dist/katex.min.css
  - assets/stylesheets/lists.css
  - assets/stylesheets/tables.css
#  - css/kroki-viewer.css