FastAPI-fastkit/mkdocs.yml at main · parthj732005/FastAPI-fastkit · 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
site_name: FastAPI-fastkit
site_description: Fast, easy-to-use starter kit for new users of Python and FastAPI
site_url: https://bnbong.github.io/FastAPI-fastkit/
repo_name: bnbong/FastAPI-fastkit
repo_url: https://github.com/bnbong/FastAPI-fastkit
theme:
  custom_dir: overrides
  name: material
  font:
    text: JetBrains Mono
  # Light and Dark Theme Toggle
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: brown
      toggle:
        icon: material/brightness-7  # current mode : light
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: brown
      toggle:
        icon: material/brightness-4  # current mode : dark
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.footer
    - navigation.top
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - search.highlight
    - search.share
    - search.suggest
    - announce.dismiss
    - toc.follow
  logo: img/FastAPI-fastkit_logo.png
  favicon: img/FastAPI-fastkit_logo.png
  language: en
plugins:
  # Material for MkDocs
  - search

nav:
  - Home: index.md
  - User Guide:
    - Installation: user-guide/installation.md
    - Quick Start: user-guide/quick-start.md
    - Creating Projects: user-guide/creating-projects.md
    - Adding Routes: user-guide/adding-routes.md
    - Using Templates: user-guide/using-templates.md
    - CLI Reference: user-guide/cli-reference.md
  - Tutorial:
    - Getting Started: tutorial/getting-started.md
    - Your First Project: tutorial/first-project.md
    - Implementing Basic API Server: tutorial/basic-api-server.md
    - Implementing Asynchronous CRUD API: tutorial/async-crud-api.md
    - Database Integration: tutorial/database-integration.md
    - Docker Deployment: tutorial/docker-deployment.md
    - Implementing Custom Response Handling: tutorial/custom-response-handling.md
    - Implementing MCP Server: tutorial/mcp-integration.md
  - Contributing:
    - Development Setup: contributing/development-setup.md
    - Code Guidelines: contributing/code-guidelines.md
    - Template Creation Guide: contributing/template-creation-guide.md
  - Reference:
    - FAQ: reference/faq.md
    - Template Quality Assurance: reference/template-quality-assurance.md
  - Changelog: changelog.md

markdown_extensions:
  # Python Markdown
  - abbr
  - attr_list
  - footnotes
  - md_in_html
  - mdx_include
  - admonition
  - pymdownx.details
  # PyMdown Extensions
  - pymdownx.highlight:  # necessary for code blocks & termynal
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite  # necessary for code blocks & termynal
  - pymdownx.snippets  # necessary for code blocks & termynal
  - pymdownx.superfences  # necessary for code blocks & termynal

extra_css:
  - css/termynal.css
  - css/custom.css

extra_javascript:
  - js/termynal.js
  - js/custom.js