fastapi-task-manager/mkdocs.yml at main · Morry98/fastapi-task-manager · 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
site_name: FastAPI Task Manager
site_description: FastAPI framework ...
repo_url: https://github.com/Morry98/fastapi-task-manager
repo_name: Morry98/fastapi-task-manager
docs_dir: docs/docs
site_dir: docs/site
use_directory_urls: false   # generate file.html instead of folders with index.html
strict: true                # build fail if there are any warnings

theme:
  custom_dir: docs/docs/overrides
  name: material
  language: en
  features:
    - content.code.annotate
    - content.code.copy
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.footer
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

  palette:
    - media: (prefers-color-scheme)
      toggle:
        icon: material/lightbulb-auto
        name: Switch to light mode
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb-outline
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/github-alt
  logo: assets/images/logo-white.svg
  favicon: assets/images/logo-circle-purple.svg

plugins:
  - search
  - glightbox
  - termynal:
      title: bash
      buttons: macos
      prompt_literal_start:
        - "$"

markdown_extensions:
  # Python Markdown
  abbr:
  attr_list:
  footnotes:
  md_in_html:
  tables:
  toc:
    permalink: true

  # Python Markdown Extensions
  pymdownx.betterem:
    smart_enable: all
  pymdownx.caret:
  pymdownx.highlight:
    line_spans: __span
  pymdownx.inlinehilite:
  pymdownx.keys:
  pymdownx.mark:
  pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
  pymdownx.tilde:

  # pymdownx blocks
  pymdownx.blocks.admonition:
    types:
    - note
    - attention
    - caution
    - danger
    - error
    - tip
    - hint
    - warning
    # Custom types
    - info
  pymdownx.blocks.details:
  pymdownx.blocks.tab:
      alternate_style: true

  # Emoji support
  pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

  # Other extensions
  mdx_include:
  markdown_include_variants:


extra_css:
  - assets/brand-colors.css
  - assets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/Morry98/fastapi-task-manager
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/morandomatteo
    - icon: custom/ciuf
      name: CIUF
      link: https://ciuf.io

extra_javascript:
  - assets/javascripts/termynal-reload.js

nav:
  - FastAPI Task Manager: index.md
  - features.md
  - Learn:
    - Getting Started:
      - learn/getting_started/index.md
      - learn/getting_started/installation.md
      - learn/getting_started/configurations.md
    - learn/api-reference.md
    - learn/dynamic-tasks.md
    - learn/architecture.md
    - learn/deployment.md
  - About: about/index.md
  - People: about/people.md
  - Release Notes: release_notes/index.md