python-project-template/mkdocs.yml at main · danibcorr/python-project-template · 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
site_name: Python project template
site_description: Python project template
repo_name: python-project-template
repo_url: https://github.com/danibcorr/python-project-template
site_url: https://danibcorr.github.io/python-project-template

theme:
  name: "material"
  language: en
  palette:
    - scheme: slate
      primary: black
      accent: black
      toggle:
        icon: material/weather-night
        name: "Switch to light mode"
    - scheme: default
      primary: black
      accent: black
      toggle:
        icon: material/weather-sunny
        name: "Switch to dark mode"
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.indexes
    - navigation.path
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - navigation.sections
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  logo: assets/images/logo.png
  favicon: assets/images/logo.png
  icon:
    repo: fontawesome/brands/github

use_directory_urls: false

markdown_extensions:
  - tables
  - toc:
      toc_depth: 2
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - attr_list
  - md_in_html
  - abbr
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

plugins:
  - search:
      lang: en
  - git-revision-date-localized
  - git-authors:
      show_email_address: false
  - enumerate-headings:
      toc_depth: 0
      exclude:
        - index.md
  - awesome-nav

extra:
  status:
    new: Recently added
    deprecated: Deprecated
  social:
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/danibcorr/
  version:
    provider: mike
    default: latest

extra_css:
  - assets/css/custom.css